home *** CD-ROM | disk | FTP | other *** search
/ Revolution - Das Atari CD Magazin 1997 / Revolution - Das Atari CD Magazin 1.iso / software / mag_prg / udo / udo6ehp7.tz / udo6ehp7 / UDO6eng / doc / udo6eng.txt < prev   
Text File  |  1997-01-04  |  315KB  |  10,012 lines
  1.                              The guide to
  2.  
  3.                                  UDO
  4.  
  5.                         Release 6 Patchlevel 0
  6.                            January 3rd 1997
  7.  
  8.                                   by
  9.  
  10.                             Dirk Hagedorn
  11.                               Asmecke 1
  12.                             59846 Sundern
  13.                                Germany
  14.  
  15.                       Internet: DirkHage@aol.com
  16.                      MausNet: Dirk Hagedorn @ MK2
  17.  
  18.  
  19.  
  20. ======================================================================
  21. Contents
  22. ======================================================================
  23.  
  24.  1  Introduction
  25.     1.1  Preface
  26.     1.2  What UDO can('t) do for you
  27.     1.3  Do you need UDO?
  28.     1.4  Once upon a time
  29.     1.5  Contact addresses
  30.     1.6  Thanks
  31.  
  32.  2  Legal information
  33.     2.1  Copyright
  34.     2.2  Disclaimer
  35.     2.3  Trademarks
  36.  
  37.  3  Money, money, money
  38.     3.1  Shareware
  39.     3.2  How much does UDO cost?
  40.     3.3  How much do upgrades cost?
  41.     3.4  Registration
  42.     3.5  Registration in Great Britain
  43.  
  44.  4  Installation
  45.     4.1  Installing the Atari version
  46.     4.2  Installing the DOS version
  47.     4.3  Installing the Macintosh version
  48.     4.4  Installing the Unix versions
  49.  
  50.  5  Usage
  51.     5.1  Command line version
  52.     5.2  GEM version
  53.     5.3  Macintosh version
  54.     5.4  UDO Shell for Windows
  55.  
  56.  6  The syntax of UDO
  57.     6.1  A short example
  58.     6.2  Basics
  59.     6.3  Structuring
  60.     6.4  Emphasising text
  61.     6.5  Special characters
  62.     6.6  Syllabification
  63.     6.7  Images
  64.     6.8  Hypertext commands
  65.     6.9  Miscellaneous
  66.  
  67.  7  Tips & tricks
  68.     7.1  Seven rules for writing UDO source files
  69.     7.2  General tips & tricks
  70.     7.3  Tips & tricks according to LaTeX
  71.     7.4  Tips & tricks according to ST-Guide
  72.     7.5  Tips & tricks concerning Windows Help
  73.  
  74. Appendix
  75. ========
  76.  
  77.  A  Frequently asked questions
  78.     A.1  General questions
  79.     A.2  Questions concerning ASCII
  80.     A.3  Questions concerning HTML
  81.     A.4  Questions concerning manpages
  82.     A.5  Questions concerning LaTeX
  83.     A.6  Questions concerning Linuxdoc-SGML
  84.     A.7  Questions concerning Pure C Help
  85.     A.8  Questions concerning the Rich Text Format
  86.     A.9  Questions concerning ST-Guide
  87.     A.10  Questions concerning Texinfo
  88.     A.11  Questions concerning Turbo Vision Help
  89.     A.12  Questions concerning Windows Help
  90.  
  91.  B  Bugs
  92.  
  93.  C  Error messages
  94.  
  95.  D  This & that
  96.     D.1  Facts, facts, facts
  97.     D.2  Programming environment
  98.     D.3  Generated files
  99.  
  100.  E  History
  101.     E.1  Last minute changes
  102.     E.2  Release 6
  103.     E.3  Release 5
  104.     E.4  Release 4
  105.     E.5  Release 3
  106.  
  107.  F  Command index
  108.     F.1  A...
  109.     F.2  B...
  110.     F.3  C...
  111.     F.4  D...
  112.     F.5  E...
  113.     F.6  F...
  114.     F.7  G...
  115.     F.8  H...
  116.     F.9  I...
  117.     F.10  L...
  118.     F.11  M...
  119.     F.12  N...
  120.     F.13  O...
  121.     F.14  P...
  122.     F.15  R...
  123.     F.16  S...
  124.     F.17  T...
  125.     F.18  U...
  126.     F.19  V...
  127.     F.20  W...
  128.     F.21  X...
  129.     F.22  *...
  130.  
  131.  
  132.  
  133. ======================================================================
  134. Chapter 1
  135.  
  136. Introduction
  137. ======================================================================
  138.  
  139.  
  140. 1.1  Preface
  141. ============
  142.  
  143. Welcome to UDO!
  144.  
  145. You are  reading  the  revised  documentation  of  the revised program
  146. called UDO written by a quite overworked author that still  is  hoping
  147. that  anybody  outside there understands his quite unrevised knowledge
  148. of writing English documentations.
  149.  
  150. UDO is a powerful and multipurpose utility for making a  documentation
  151. or  any  other  text  file  that is needed in one text format or more.
  152. Though UDO is powerful it's quite easy to understand and to use.
  153.  
  154. If you take a look at the size of this documentation you  will  notice
  155. immediately that UDO has to be quite powerful. Many users get deterred
  156. of the size of this documentation and try to use  UDO  without  having
  157. read  it.  Unfortunately,  exactly  these  people  will  ask  lots  of
  158. questions later on without  knowing  that  their  questions  could  be
  159. answered by simply reading this documentation.
  160.  
  161. Due to this fact I want to note at the beginning of this documentation
  162. that you will only be able to use UDO in an efficient way if you  read
  163. the  complete  documentation  one  time at least and if you experiment
  164. with the added examples.
  165.  
  166. Please take some time, sit down, take a cup of tea or coffee and  read
  167. this  documentation  from  the beginning to the end. You don't have to
  168. learn everything by heart but  you  should  be  able  to  find  things
  169. quickly if there will be questions later on.
  170.  
  171. If you  will  detect  parts where things are described in a too short,
  172. wrong or misleading way: please let me know! UDO is "my little  child"
  173. and  it  wouldn't  be  the  first time that an author has forgotten to
  174. describe some important parts.
  175.  
  176. And if you have any problems with my English: please let me know, too!
  177. I  did  what I can but you without any doubts you will find some awful
  178. parts.
  179.  
  180.  Please note that UDO is Shareware. I have been spending a lot of my
  181.  spare time for this project. If you want to use UDO please register
  182.                                for it.
  183.  
  184. I hope that UDO will become an unrenounceable utility for you and  you
  185. will have more time for the really important things.
  186.  
  187. Dirk Hagedorn
  188.  
  189. Sundern, December 10th 1996
  190.  
  191.  
  192. 1.2  What UDO can('t) do for you
  193. ================================
  194.  
  195. UDO has  been  originally developed to make it easier for you to write
  196. software documentations or other kinds of text files that have  to  be
  197. available in more than one format.
  198.  
  199. UDO can  be  a  great  help  if  you want to make a single destination
  200. format, too. A beginner will have less problems when learning the  UDO
  201. syntax instead of learning LaTeX or HTML. So if you want to make LaTeX
  202. or HTML files it should be easier to get to  know  how  to  make  them
  203. using  UDO  instead of writing them on your own. When writing LaTeX or
  204. HTML files you have to keep attention not to use any of their  special
  205. command  characters.  In  comparison  to  that  UDO will convert these
  206. special characters for you when converting the source file to LaTeX or
  207. HTML. But this is not the only thing UDO can do for you.
  208.  
  209. UDO is  a  multilingual program. You can make German, English, French,
  210. Italian  and  Swedish  texts.  UDO  knows  how  "Table  of  contents",
  211. "Appendix",  "Figure" or "Table" is called in the other countries. The
  212. date is also printed out in the right way  depended  of  the  selected
  213. language.
  214.  
  215. The syntax  of UDO is easy to learn. To make some small documentations
  216. you just have to learn about ten to fifteen commands; as many  as  you
  217. have to learn when you try to learn LaTeX or HTML.
  218.  
  219. When you  have  written an UDO source file you can convert it into the
  220. following formats:
  221.  
  222.   1. Apple QuickView
  223.   2. ASCII
  224.   3. HTML (Hypertext Markup Language)
  225.   4. LaTeX 2.09, LaTeX2e
  226.   5. Linuxdoc-SGML
  227.   6. LyX
  228.   7. Manualpage
  229.   8. NROFF
  230.   9. Pure C Help
  231.  10. RTF (Rich Text Format)
  232.  11. Source code (C and Pascal)
  233.  12. ST-Guide
  234.  13. Texinfo
  235.  14. Turbo Vision Help
  236.  15. Windows Help
  237.  
  238. As you  can  see  some  formats  are  just  interesting  for  specific
  239. operating  systems,  but  you can also see that the list contains come
  240. formats that can be used on nearly any existing operating system.
  241.  
  242. In most cases UDO doesn't make files that are  ready  to  use  because
  243. have to run a further software to view, print or convert the document.
  244. E.g. you have to convert the Windows Help source file (saved  by  UDO)
  245. with  the  Microsoft Help Compiler HC.EXE into a Windows Help file. Or
  246. you have to import the RTF file into a text processor to print it.
  247.  
  248.  
  249. UDO tries to help the author of a documentation as much  as  possible.
  250. Next  to the conversion into the destination format UDO offers you the
  251. following features:
  252.  
  253.    ⁿ automatically generated title pages,  tables  of  contents,  head
  254.      lines and bottom lines,
  255.    ⁿ chapter numbering,
  256.    ⁿ tables,
  257.    ⁿ automatically generated hypertext links,
  258.    ⁿ support for different text styles,
  259.    ⁿ automatic conversion of umlauts and other special characters,
  260.    ⁿ a  large  variety  of  layout commands for making lists, enumera-
  261.      tions, descriptions, justified text, centred or indented text  or
  262.      text with a right alignment,
  263.    ⁿ image support,
  264.    ⁿ automatic line breaks with a half-automatic syllabification.
  265.  
  266.  
  267. UDO is  not  the perfect program for all purposes. The conversion into
  268. ASCII, ST-Guide, HTML, LaTeX and Windows Help is nearly perfect.  Some
  269. formats  (like Linuxdoc-SGML and LyX) are quite young and haven't been
  270. tested enough. You will surely find  some  aspects  that  have  to  be
  271. changed in the near future.
  272.  
  273. There are  some points that UDO can't manage yet but will be implemen-
  274. ted in the very near future: a automatically generated index, list  of
  275. figures and list of tables. Just wait some months and you will get UDO
  276. Release 7 with all these features.
  277.  
  278.  
  279. To make complex files like newspapers  that  is  impossible  with  UDO
  280. because  it can't wrap text around images and it can't generated files
  281. with two or more text columns. In addition to that UDO hasn't  got  an
  282. implemented automatic syllabification.
  283.  
  284. UDO is  just  a  "one way" converter. UDO can't convert LaTeX, HTML or
  285. RTF to the UDO format. It is only able to convert the UDO format  into
  286. LaTeX etc. Maybe there will be a HTML2UDO or SGML2UDO converter in the
  287. near future.
  288.  
  289. To sum it up it can be said that UDO can't manage the following things
  290. and won't be able to manage them in the future:
  291.  
  292.   1. UDO  can only convert its format into the upper standing formats.
  293.      UDO can't convert them into its own format. Maybe there  will  be
  294.      some other converters in the near future.
  295.   2. UDO  can't  make  binary formats (like WinWord documents). It can
  296.      only make make formats that are based on ASCII.
  297.   3. UDO doesn't support an automatic  syllabification.  You  have  to
  298.      tell  UDO  explicitely  where  it is allowed to split up words. I
  299.      don't want to  implement  an  automatic  syllabification  because
  300.      there are only some formats that would profit from it.
  301.   4. UDO  can't wrap text around images. UDO can't save multi-columned
  302.      texts, too. These functions are part of  desktop  publishing  and
  303.      not of a software like UDO.
  304.  
  305.  
  306. 1.3  Do you need UDO?
  307. =====================
  308.  
  309. If you can answer one or more of the following question with "Yes" UDO
  310. should be worth to take a look at. If can't answer any  question  with
  311. "Yes"  it's  quite  possible  that you don't need UDO and that you can
  312. stop reading this manual right here.
  313.  
  314.    ⁿ Have you written a text with a general contents and do  you  want
  315.      to  let  some  people,  that don't run the same operating system,
  316.      read it?
  317.  
  318.    ⁿ Are you a programmer and do you want to distribute your  software
  319.      with  an  ASCII  manual  and  an online manual for Windows, Turbo
  320.      Vision, GNU Info or ST-Guide?
  321.  
  322.    ⁿ Are you a programmer and do you want to print out the manual with
  323.      LaTeX or a text processor that can import the Rich Text Format?
  324.  
  325.    ⁿ Do  you  only  need  an  ASCII  manual  but you always get rid of
  326.      checking the line  breaks,  chapter  numbers  and  the  table  of
  327.      contents?
  328.  
  329.    ⁿ Do  you want to publish a hypertext inside the World Wide Web but
  330.      you don't own a  powerful  HTML  editor  that  can  enter  links,
  331.      convert   special  characters  or  split  up  the  document  into
  332.      different files automatically?
  333.  
  334.    ⁿ Do you want to make an online manual for a Windows  software  but
  335.      you  don't  want  to pay a lot of money for a software that costs
  336.      more than 20 times the price of UDO but can do only a little  bit
  337.      more?
  338.  
  339.    ⁿ Are  you  the  author of a Pure C library for the Atari computers
  340.      and you need a descriptions of the library routines  for  Pure  C
  341.      Help and ST-Guide?
  342.  
  343. Did you  answer  any  question with "Yes"? Fine! You didn't? Then read
  344. the questions once more. ;-)
  345.  
  346.  
  347. 1.4  Once upon a time
  348. =====================
  349.  
  350. It was autumn 1994 when I wrote  some  little  programs  for  which  I
  351. needed an ASCII manual, an online help and a printed documentation.
  352.  
  353. In all  cases  I  began  writing  the  ASCII manual. In a copy of it I
  354. inserted hypertext commands. Finally the  ASCII  manual  was  imported
  355. into  a  text  processor,  layouted and printed. It didn't take a long
  356. time for me to recognize that this was an inefficient work:  if  there
  357. were any changes in one of the files both the others had to be changed
  358. in the same way. And if there were lots of changes it was necessary to
  359. start the whole procedure right from the beginning.
  360.  
  361. When I  finished  these  manuals I said to myself: "Oh no, Dirk, there
  362. must be another and easier way to get different versions of  one  text
  363. file!".
  364.  
  365. January 1995  I  started  to  think  about  a new text format with the
  366. project name "UDO" (as the abbreviation for Universal  DOcument).  The
  367. UDO  syntax  should  be  easy  to  learn  and flexible enough and so I
  368. decided to create a syntax like LaTeX. Next to this  I  began  writing
  369. the software that was able to convert this new text format into ASCII,
  370. ST-Guide and LaTeX: UDO was born!
  371.  
  372. At this time UDO was really a small program with only  some  features.
  373. The  syntax  contained about 10 commands and the source code was about
  374. 10 KB large. Nevertheless this small hack was  of  a  great  help  for
  375. myself and the upper described horror scenario was history.
  376.  
  377. Since this  time  UDO has been growing up day by day. UDO now supports
  378. many different text formats, it offers a large  variety  of  layouting
  379. commands,  it's  available for different operating system and the size
  380. of its source code and documentation is now  a  hundred  times  larger
  381. than it was in former days.
  382.  
  383. In these  two years UDO has become to an operating system independent,
  384. very powerful and - proverbially said - universal tool.
  385.  
  386.  
  387. 1.5  Contact addresses
  388. ======================
  389.  
  390. If you want to register UDO, if you want have questions, if  you  want
  391. to  make  any suggestions or if you want to report bugs please use one
  392. of the following addresses. If possible contact me via email.
  393.  
  394.  Address:        Dirk Hagedorn
  395.                  Asmecke 1
  396.                  59846 Sundern
  397.                  Germany
  398.  
  399.  Telephone/Fax:  +49 2933 77979
  400.  
  401.  MausNet:        Dirk Hagedorn @ MK2 (no mails > 16 KB)
  402.  
  403.  Internet:       DirkHage@aol.com
  404.  
  405.  World Wide Web: http://members.aol.com/DirkHage/www/index.htm
  406.  
  407.  
  408. 1.6  Thanks
  409. ===========
  410.  
  411. At this point I want to  say  "Thank  you"  to  the  following  people
  412. because  of  their  effective  help. Without this help UDO wouldn't be
  413. like it is today.
  414.  
  415. Thank you
  416.  
  417.  Denesh Bhabuta for supporting UDO in Great Britain
  418.  
  419.  Alexander Clauss for compiling the HP-UX 300/400 version
  420.  
  421.  Dirk Haun, one of the fathers of UDO
  422.  
  423.  Patrick Jerchel for managing the mailing list
  424.  
  425.  Peter Klasen, the first registered user of UDO
  426.  
  427.  Martin Loos for managing the old mailing list
  428.  
  429.  Martin Osieka for porting UDO to MacOS
  430.  
  431.  Rainer Riedl for compiling the BeOS version
  432.  
  433.  Tom Thomasson for supporting UDO in Sweden
  434.  
  435. In addition to that I want  to  thank  all  users  of  UDO  for  their
  436. indefatigable efforts to make UDO better and better.
  437.  
  438.  
  439.  
  440. ======================================================================
  441. Chapter 2
  442.  
  443. Legal information
  444. ======================================================================
  445.  
  446.  
  447. 2.1  Copyright
  448. ==============
  449.  
  450. UDO and  its  documentation are copyrighted by Dirk Hagedorn, Sundern,
  451. Germany.
  452.  
  453. UDO is distributed as shareware and may be copied to third persons  in
  454. a noncommercial way if all the following requirements are met:
  455.  
  456.    ⁿ You have to copy the software with all and unchanged files.
  457.  
  458.    ⁿ You  have to copy the software free of charge. Uploading UDO to a
  459.      noncommercial BBS or FTP server is allowed.
  460.  
  461.    ⁿ You aren't allowed to add files to the archives  e.g.  advertise-
  462.      ments  for  a BBS or for Public Domain series. You aren't allowed
  463.      to rename the archives  or  to  to  compress  them  with  another
  464.      archiver.
  465.  
  466.    ⁿ If  you want to distribute UDO via Public Domain floppy discs you
  467.      may do this only if the price of a single floppy  disc  is  lower
  468.      than  5  Pounds  Sterling,  6 $US and 10 DM (or the same value in
  469.      another currency).
  470.  
  471.    ⁿ If you want to distribute UDO via CD-ROM you may do this only, if
  472.      I,  Dirk  Hagedorn, will get a copy of this CD-ROM free of charge
  473.      and the if the CD-ROM will  be  published  before  December  31st
  474.      1997.  I  want to avoid that old versions of UDO are still copied
  475.      even if there are out of date. If you  read  this  text  1998  or
  476.      later  please  contact  me  to  get  to know if there's a younger
  477.      version existing!
  478.  
  479.  
  480. 2.2  Disclaimer
  481. ===============
  482.  
  483. Though UDO has been developed thoroughly and has  been  tested  for  a
  484. long  period  of  time  there  is  no  warranty for the program or the
  485. contents of this documentation.
  486.  
  487. UDO is provided "as is" without warranty of any  kind,  including  but
  488. not  limited to, the implied warranties of merchantability and fitness
  489. for a particular purpose. The entire risk  is  with  you.  Should  UDO
  490. prove defective you assume the cost of all necessary servicing, repair
  491. or correction.
  492.  
  493. Nevertheless the author will be glad if you send him bug reports.
  494.  
  495.  
  496. 2.3  Trademarks
  497. ===============
  498.  
  499. This documentation uses names of products and companies  that  may  be
  500. trademarks  or  registered trademarks. You may not conclude that these
  501. names are free of use even if they are not marked explicitly.
  502.  
  503. Atari, TOS and MultiTOS are trademarks  or  registered  trademarks  of
  504. Atari Corporation.
  505.  
  506. Arial and  Times  New  Roman  are  registered  trademarks  of Monotype
  507. Corporation PLC.
  508.  
  509. GEM and GEM Desktop are trademarks or registered trademarks of Digital
  510. Research.
  511.  
  512. Mac, Macintosh  and  MacOS are registered trademarks of Apple Computer
  513. Inc.
  514.  
  515. MS-DOS, Windows, Windows 95 and Windows NT are  registered  trademarks
  516. of Microsoft Corporation.
  517.  
  518. Unix is a registered trademark of X/Open Company Ltd.
  519.  
  520.  
  521.  
  522. ======================================================================
  523. Chapter 3
  524.  
  525. Money, money, money
  526. ======================================================================
  527.  
  528.  
  529. 3.1  Shareware
  530. ==============
  531.  
  532. UDO is distributed as shareware. This means:
  533.  
  534.    ⁿ You are allowed to check for exactly four weeks if UDO meets your
  535.      requirements!
  536.  
  537.    ⁿ It's forbidden to publish any text you have made with UDO  during
  538.      this trial period.
  539.  
  540.    ⁿ After  the  trial period of four weeks you have to decide whether
  541.      you want to buy UDO (see "Registration") or if you don't want  to
  542.      use  it. If you don't want to buy UDO you are obligated to delete
  543.      UDO and all its additional files from  your  hard  disc.  If  you
  544.      don't you will work with a black copy of UDO!
  545.  
  546. If I will get less registrations than I expect I...
  547.  
  548.   1. ...will increase the number of limitations (e.g. limited document
  549.      sizes, exchanged characters in the destination file or ugly speed
  550.      limitations), or I...
  551.  
  552.   2. ...won't  publish  further  versions of UDO and give them only to
  553.      registered users, or I...
  554.  
  555.   3. ...will stop going on developing UDO.
  556.  
  557. That's no joke! In the past I was often disappointed due to the amount
  558. of  registrations  I got for other software of mine. Please believe me
  559. that I cannot laugh anymore about users that are too lazy to  pay  for
  560. shareware.
  561.  
  562. In former  versions  UDO  didn't  have any limitations. But due to the
  563. unsatisfying  resonance  from  Unix  and  DOS  users   I   implemented
  564. limitations in all UDO versions:
  565.  
  566.   1. UDO will print an ugly message at the end of every page.
  567.  
  568.   2. The  switch  !use_about_udo is set automatically for all destina-
  569.      tion formats.
  570.  
  571. When you have paid the shareware  fee  you  will  get  a  personalised
  572. keycode.  With  this  keycode  you  will  be  able  to  disable  these
  573. limitations.
  574.  
  575.  
  576. 3.2  How much does UDO cost?
  577. ============================
  578.  
  579. You can believe me that I have thought very long about  the  price  of
  580. UDO. So please read this section until the end.
  581.  
  582. I don't  want  to tell you the price I would have to demand because it
  583. is higher than an averaged user wants to pay for  shareware  nowadays.
  584. But I think that the current price of UDO is a good compromise between
  585. "dream and reality". I hope that it's fair enough for you and  UDO  is
  586. worth paying this amount of money.
  587.  
  588. The height  of  the  shareware fee depends on your status, whether you
  589. want to use UDO for private, commercial or educational purposes:
  590.  
  591.  
  592. The price for private users
  593. ===========================
  594.  
  595. The shareware fee for a systemwide licence of UDO for private users is
  596. 50 DM (35 $US, 25 Pounds Sterling, 40 SFR, 350 םS, 55 NFL, 150 FF).
  597.  
  598. You are  a  private user if you make documentations or other texts for
  599. products that cost less than  100 DM  (70  $US,  50  Pounds  Sterling,
  600. 80 SFR, 700 םS, 110 NFL, 34 FF). Thus all authors that are programming
  601. only freeware, public domain or shareware that cost less  than  100 DM
  602. are private users.
  603.  
  604. Private users   have  to  pay  the  shareware  only  once.  After  the
  605. registration private users are allowed to use  UDO  simultaneously  on
  606. any operating system UDO is available for.
  607.  
  608. If you  recognize that you are a commercial user after having paid the
  609. shareware fee for private users you are forced to pay the difference!
  610.  
  611.  
  612. The price for commercial users
  613. ==============================
  614.  
  615. The shareware fee for a single licence of UDO for commercial users  is
  616. 150 DM (100 $US,   75  Pounds  Sterling,  120 SFR,  1050 םS,  165 NFL,
  617. 450 FF). "Single licence" means that UDO may only be installed on  one
  618. computer that isn't connected to any kind of network.
  619.  
  620. If you  want  to use UDO on several computers or in a network you have
  621. to  buy  additional  licences  for  any  additional  working   places.
  622. Additional  licences  costs  50 DM each  (35 $US,  25 Pounds Sterling,
  623. 40 SFR, 350 םS, 55 NFL,  150 FF).  You  have  to  guarantee  that  the
  624. maximum  number  of  users  of UDO cannot be higher than the amount of
  625. licences you have bought.
  626.  
  627. If you need 20 or more licences you can ask me for a special price for
  628. your specific needs.
  629.  
  630. A commercial  user is who uses UDO for writing documentations or other
  631. texts for one or more products that cost more than 100 DM (70 $US,  50
  632. Pounds Sterling, 80 SFR, 700 םS, 110 NFL, 34 FF).
  633.  
  634. Companies, enterprises and other commercial oriented institutions that
  635. use UDO for internal purposes are commercial users, too.
  636.  
  637.  
  638. The price for schools and universities
  639. ======================================
  640.  
  641. I offer special prices for schools, universities and other educational
  642. institutions.  Please  ask  me  for the price for the amount of needed
  643. licences.
  644.  
  645. Please note:
  646.  
  647.   1. All prices are inclusive value-added tax.
  648.  
  649.   2. After having paid the shareware fee you will receive  an  invoice
  650.      and a personalized keycode. With this keycode you will be able to
  651.      disable the limitations of the shareware version.
  652.  
  653.   3. If you think (like myself) that UDO is worth more than the  upper
  654.      shown prices, don't hesitate to pay more.
  655.  
  656.  
  657. A last request...
  658. =================
  659.  
  660. Dear private users, if you want to use UDO without any twinges at your
  661. working place, please try to convince your boss or any other  superior
  662. to buy one ore more licences of UDO.
  663.  
  664. The low  price  of UDO can be afforded by really every company and can
  665. be completely depreciated.
  666.  
  667. Every additional income can help me to cover  my  costs  payments  for
  668. books,  compilers  and  telephone/modem  calls. And you can believe me
  669. that these costs aren't low due to the size of this project.
  670.  
  671.  
  672. 3.3  How much do upgrades cost?
  673. ===============================
  674.  
  675. You have to pay an upgrade fee for upgrading an  old  release  to  the
  676. current one.
  677.  
  678. The height  of  this  upgrade  fee  depends  on which release you have
  679. currently  registered  and  if  you  are  a  private,  commercial   or
  680. "educational"  user.  The  following  table  shows the upgrade fees in
  681. Deutsche Mark. The second table shows you  the  equivalent  values  in
  682. your currency.
  683.  
  684.  
  685.      from           to        | Private | Commercial | Education 
  686.     --------------------------+---------+------------+-----------
  687.      Release 3      Release 6 |   15 DM |   50/10 DM |        -- 
  688.      Release 4      Release 6 |   10 DM |   30/10 DM |        -- 
  689.      Rel. 5 (1996)  Release 6 |    0 DM |       0 DM |      0 DM 
  690.      Rel. 5 (1997)  Release 6 |   10 DM |   50/10 DM |  50/10 DM 
  691.  
  692.  
  693.                DM | $US | Pounds | sFR |  מS | nFL  FF  
  694.               ----+-----+--------+-----+-----+----------
  695.                10 |   7 |      5 |  13 |  70 |  11  30  
  696.                15 |  10 |      8 |  20 | 105 |  17  45  
  697.                30 |  20 |     15 |  40 | 210 |  34  60  
  698.                50 |  35 |     25 |  65 | 350 |  56  150 
  699.  
  700. If you have registered UDO Release 5 in 1996 you don't have to pay any
  701. upgrade fee. The new keycodes will be sent to  you  on  demand  (email
  702. preferred).
  703.  
  704. If you have registered UDO Release 5 in 1997 or later you will have to
  705. pay the upgrade fees listed in the table in the row labelled  "Rel.  5
  706. (1997)".
  707.  
  708. The values in the columns for commercial and educational users are the
  709. upgrade fees  for  the  first  licence  (left  value)  and  additional
  710. licences (right value).
  711.  
  712.  
  713. 3.4  Registration
  714. =================
  715.  
  716. The height of the shareware or upgrade fee depends on your status. How
  717. much money you have to pay you will find in "How much does UDO  cost?"
  718. and "How much do upgrades cost?".
  719.  
  720. Users from  Great  Britain  are recommended to register UDO via Denesh
  721. Bhabuta. Users from Sweden are recommended to  register  UDO  via  Tom
  722. Thomasson.
  723.  
  724. The appropriate  amount  of  money  can be paid by sending a cheque, a
  725. Eurocheque or cash or by transferring the amount of money to  my  bank
  726. account.
  727.  
  728. If you  really want to risk to send cash please send Deutsche Mark and
  729. insert a black piece of paper into the envelope  so  nobody  can  look
  730. inside gets the idea to steal the letter.
  731.  
  732. Please send cheques, Eurocheques or cash to:
  733.  
  734.      Dirk Hagedorn
  735.      Asmecke 1
  736.      59846 Sundern
  737.      Deutschland
  738.  
  739. If you  prefer  transferring  the  money  to my bank account use these
  740. data:
  741.  
  742.       Account holder: Dirk Hagedorn
  743.       Account number: 3 561 164
  744.       Bank:           Sparkasse Arnsberg-Sundern, Germany
  745.       Bank code:      466 500 05
  746.  
  747. In all cases please don't forget to send me
  748.  
  749.    ⁿ your name
  750.    ⁿ your complete address
  751.    ⁿ your email address (if available)
  752.    ⁿ on which operating system(s) you want to use UDO
  753.  
  754. After having received  the  money  I  will  send  you  a  bill  and  a
  755. personalized keycode. With the keycode you can disable the limitations
  756. of the shareware version.
  757.  
  758.  
  759. Services for registered users
  760. -----------------------------
  761.  
  762. New releases of UDO are released  two  or  three  times  per  year  at
  763. maximum.  Registered users are enabled to use current beta versions at
  764. any time.
  765.  
  766. Because UDO is available for many operating systems and I  don't  have
  767. so  much  time to compile new release every time I change some things,
  768. new releases will be published only if the number of changes  is  high
  769. enough.
  770.  
  771. For registered  users  after  about  two  weeks  updated  versions are
  772. published. In these  version  old  bugs  are  fixed,  new  destination
  773. formats are presented and wishes of registered users are considered if
  774. they may be realised.
  775.  
  776. Registered users can download these updates via modem or FTP  or  they
  777. can  order  them  by sending a formated floppy disk with a readdressed
  778. envelope and 2 DM for stamps.
  779.  
  780. It goes without saying that registered users will get  gratis  support
  781. via  via  (e)mail.  Questions  of registered users will be answered as
  782. detailed as possible.
  783.  
  784.  
  785. 3.5  Registration in Great Britain
  786. ==================================
  787.  
  788. It's recommended that British users register UDO via  Denesh  Bhabuta.
  789. Users from outside Great Britain should register UDO directly via Dirk
  790. Hagedorn.
  791.  
  792. The shareware fee depends on your status. How much money you  have  to
  793. pay  you  will  find  in  "How  much  does  UDO cost?" or "How much do
  794. upgrades cost?".
  795.  
  796. To register UDO via Denesh Bhabuta please  send  a  cheque  or  postal
  797. order  for  the  appropriate  amount made payable to "Denesh Bhabuta".
  798. Denesh also accepts Eurocheques and International  Money  Orders  made
  799. payable to him. Send this along with your full address, e-mail address
  800. and a short note which version of UDO on which  operating  system  you
  801. are using to
  802.  
  803.  Address: Denesh Bhabuta
  804.           CyberSTrider
  805.           203 Parr Lane
  806.           Bury
  807.           BL9 8JW
  808.  
  809.  E-Mail:  dbhabuta@cix.compulink.co.uk
  810.           danny@micros.hensa.ac.uk
  811.           dbhabuta@mag-net.co.uk
  812.  
  813. When you register, you are entitled to
  814.  
  815.    ⁿ Master Disk with latest version(s) of UDO
  816.  
  817.    ⁿ Keycode to register this versions of UDO
  818.  
  819.    ⁿ E-mail, snail-mail and telephone support
  820.  
  821.    ⁿ Free  update  service  (as  long  as  the  fee doesn't rise or it
  822.      becomes commercial)
  823.  
  824. Your keycode will initially be sent by e-mail if possible.  Users  who
  825. register  via  Denesh  are  entitled  to this service. To receive free
  826. updates, please send a blank unlabelled floppy  disk  with  a  stamped
  827. self addressed envelope to the above address.
  828.  
  829.  
  830.  
  831. ======================================================================
  832. Chapter 4
  833.  
  834. Installation
  835. ======================================================================
  836.  
  837.  
  838. 4.1  Installing the Atari version
  839. =================================
  840.  
  841. To install  UDO  onto  an  Atari  or onto a computer with a compatible
  842. operating system (e.g. MagiCMac, MagiC-PC, GEMulator)  just  copy  all
  843. files to a directory that should be named "UDO".
  844.  
  845. The GEM  version  should  be the application for files with the suffix
  846. `*.u*' so you shall do the neccessary changes in your desktop (Gemini,
  847. Thing, Ease, Magxdesk, ...).
  848.  
  849. If you  prefer  the TTP version and you are using a command line shell
  850. (e.g. Mupfel by Stefan Eissing) copy or move `udo.ttp' to one  of  the
  851. directories that is part of $PATH (e.g. `\usr\bin').
  852.  
  853. If you  have  installed  the  ST-Guide  you  should copy or move UDO's
  854. hypertext (udo6eng.hyp and udo6eng.ref) to the directory that contains
  855. all your other hypertexts.
  856.  
  857. That's all.
  858.  
  859.  
  860. 4.2  Installing the DOS version
  861. ===============================
  862.  
  863. You need  a  80386  processor  at least to run UDO. UDO doesn't run on
  864. 80286 processors or processors of an older type and  I  won't  compile
  865. versions for these old dinosaurs.
  866.  
  867. If you  find  a  program  or  batch file named SETUP or INSTALL in the
  868. archive please start it and follow the instructions. If the  installa-
  869. tion fails, please go on reading this chapter.
  870.  
  871. It failed? Ah, you haven't tested it yet? That's fine that you want to
  872. read all the text before you want to experiment. ;-)
  873.  
  874. Unfortunately the installation of the DOS version is not trivial.  Er,
  875. I  think  it  is trivial but the experiences of the past have shown me
  876. that lots of people have problems installing UDO on a DOS PC  although
  877. the installation is very simple.
  878.  
  879. If you  haven't  heard anything of RSX and EMXRT until now I recommend
  880. to read the following two chapters completely. If UDO still refuses to
  881. run you have done something wrong or I haven't described the installa-
  882. tion process detailed enough.
  883.  
  884. If you already know what RSX and EMXRT are good for, because  you  are
  885. using emTeX or the GNU utilities) you can skip the next chapter.
  886.  
  887.  
  888. 4.2.1  Installation of RSX and EMXRT
  889. ------------------------------------
  890.  
  891. OK, you  haven't  heard  anything  of  RSX and EMXRT yet. That's not a
  892. shame. But if you won't know what RSX and EMXRT  are  good  for  after
  893. having  read this chapter, you should feel ashamed. And if some RSX or
  894. EMXRT experts recognize some stupid stuff I should feel ashamed.
  895.  
  896. Well, let's go...
  897.  
  898. UDO was compiled with the GNU C Compiler (GCC), strictly speaking with
  899. EMX-GCC (ported by Eberhard Mattes). GCC is originally a Unix software
  900. and Unix has always used 32 bit software. Thus, the EMX-GCC  makes  32
  901. bit  software,  too. And now we have a problem, because you cannot run
  902. 32 bit software with DOS without using any tricks.
  903.  
  904. EMXRT and RSX are responsible for these tricks. These "drivers"  allow
  905. UDO  to  allocate  huge  blocks  of  memory.  Because  you have to use
  906. different tricks for DOS and Windows there are existing two  different
  907. "drivers": EMXRT for DOS and OS/2, RSX for Windows.
  908.  
  909. Please note:
  910.  
  911.    ⁿ For running UDO exclusively in a DOS box with Windows 3.11/95 you
  912.      will need only RSX. RSX, written by Rainer Schnitker, is  a  DPMI
  913.      server for programs that were compiled with EMX-GCC or DJGPP.
  914.  
  915.    ⁿ For  running  UDO  under  OS/2  or exclusively under DOS (without
  916.      Windows) you will need only EMXRT. EMXRT ("emx  runtime  environ-
  917.      ment"), written by Eberhard Mattes, is needed for running EMX-GCC
  918.      compiled software.
  919.  
  920.    ⁿ If you don't install neither RSX  nor  EMXRT  there  will  be  no
  921.      chance to run UDO. It will simply print an error message.
  922.  
  923.    ⁿ The  installation of RSX and EMXRT is very easy. Just extract the
  924.      archives with paths and enter two lines into the AUTOEXEC.BAT.
  925.  
  926.    ⁿ RSX and EMXRT are  no  resident  drivers.  UDO  will  start  them
  927.      automatically. After UDO has finished the drivers terminate, too.
  928.  
  929.    ⁿ If  you  haven't  received  the drivers (you haven't EMXRT.ZIP or
  930.      DPMIGCC5.ZIP/RSX503RT.ZIP)  and  the  UDO  distribution   doesn't
  931.      contain  the  archives  you  can download them or you can request
  932.      them by mail:
  933.  
  934.       FTP:   Current version of EMXRT can be downloaded from ftp.uni-
  935.              stuttgart.de/pub/systems/os2/emx-0.9b/
  936.              Current versions of RSX can be downloaded from: ftp.uni-
  937.              bielefeld.de/pub/systems/msdos/misc/
  938.       Modem: You can download the files from the BBS called "Maus  MK2
  939.              Iserlohn-Kalthof"    (+49    2371    944925)   from   the
  940.              "Gruppenprogrammteil UDO.PUB".
  941.       Mail:  Just send me a formatted floppy disk  and  a  readdressed
  942.              envelope  and 2 DM (or a convertible amount of money) for
  943.              postage.
  944.  
  945. Let's talk about the installtion of RSX and EMXRT. Of course, you  can
  946. install only one of the drivers if you run exclusively DOS or Windows.
  947. The following descriptions tells you how to install both drivers.
  948.  
  949. In first place you have to extract the archives. Stop! It's  importand
  950. that  you  extract  the  archives  with  paths!  If you don't let your
  951. archiver generate paths nothing will  function.  I  recommend  to  use
  952. UNZIP.EXE.  If  you extract the RSX archive a directory `RSX\' will be
  953. saved. If you extract EMXRT a directory `EMX\' will be saved.  If  you
  954. don't find these directories something went wrong.
  955.  
  956. You can  move  the  directories to any position of your file system. I
  957. recommend to move them to  `C:\DRIVERS'.  If  this  directory  doesn't
  958. exist you have to create one.
  959.  
  960. After having extracted the archives you have to edit your AUTOEXEC.BAT
  961. and to insert the following lines. If you have only  installed  EMXRT,
  962. insert the lines below "Only EMXRT" and so on:
  963.  
  964.    ⁿ Only EMXRT:
  965.  
  966.      SET EMX=C:\DRIVERS\EMX\BIN\EMX.EXE
  967.  
  968.    ⁿ EMXRT and RSX:
  969.  
  970.      SET EMX=C:\DRIVERS\EMX\BIN\EMX.EXE
  971.      SET RSX=C:\DRIVERS\RSX\BIN\RSX.EXE
  972.  
  973.    ⁿ Only RSX:
  974.  
  975.      SET EMX=C:\DRIVERS\RSX\BIN\RSX.EXE
  976.      SET RSX=C:\DRIVERS\RSX\BIN\RSX.EXE
  977.  
  978. If RSX  and  EMXRT  haven't been installed in `C:\DRIVERS' you have to
  979. adjust the upper paths.
  980.  
  981. I think  you  already  know  that  changes  of  the   AUTOEXEC.BAT are
  982. activated  when  rebooting  your  computer.  Before  you  reboot  your
  983. computer I just want to summarize what you have done  until  now:  you
  984. have  installed some files and you have inserted one or two lines into
  985. your AUTOEXEC.BAT. That's all.
  986.  
  987. And now, reboot your computer.
  988.  
  989.  
  990. 4.2.2  Installation of UDO386.EXE
  991. ---------------------------------
  992.  
  993. Let's talk of the easier part of the installation of UDO. The abridged
  994. version: extract the archive and add the UDO directory to PATH of your
  995. AUTOEXEC.BAT.
  996.  
  997. But once more I will describe you the installation step by step:
  998.  
  999.   1. Extract the UDO archvie with paths. If you won't find a directory
  1000.      named  `UDO\'  something went wrong. If you will find it move the
  1001.      directory named `UDO\' to any position of your file  system.  The
  1002.      following  descriptions  assume that you move `UDO\' to your root
  1003.      directory.
  1004.  
  1005.   2. Now you have to let DOS find the executable:
  1006.  
  1007.       (a) Edit the AUTOEXEC.BAT and insert the following line:
  1008.  
  1009.           SET PATH=%PATH%;C:\UDO\BIN
  1010.  
  1011.           This meand that DOS and Windows will look  for  `UDO386.EXE'
  1012.           in   this  directory,  too,  when  you  have  rebootet  your
  1013.           computer.
  1014.  
  1015.       (b) If you don't like to  extend  your  PATH you  can  move  the
  1016.           executables  of `C:\UDO\BIN' to any directory that's already
  1017.           listet in PATH. Using this method you don't have  to  reboot
  1018.           your computer.
  1019.  
  1020.  
  1021. 4.3  Installing the Macintosh version
  1022. =====================================
  1023.  
  1024. After having extracted the archive that contains the Macintosh version
  1025. of UDO you can move UDO's files to any place of your file  system  you
  1026. want to. In most cases this would be the "Programs" directory.
  1027.  
  1028. UDO is  available  as  a  fat-binary  so  it  will  run  both on a 68k
  1029. Macintosh and a PowerPC Macintosh. If you want to save some disk space
  1030. you may be smaller the program with a certain software.
  1031.  
  1032. If you  have  access  to  the hypertext of UDO (`UDO6GER.HYP') you can
  1033. read it with "Hyperion". Hyperion is  a  software  written  by  Martin
  1034. Osieka  that  can display ST-Guide hypertexts. When using Hyperion you
  1035. should copy `UDO.HYP' to the Hyperion directory.
  1036.  
  1037.  
  1038. 4.4  Installing the Unix versions
  1039. =================================
  1040.  
  1041. After having extracted  the  archive  copy  the  files  of  `bin/'  to
  1042. `/usr/local/bin' or any other directory of $PATH.
  1043.  
  1044. Copy the manpage `udo.1' to `/usr/man/man1/'.
  1045.  
  1046. To read  the documentation of UDO with GNU Info convert the UDO source
  1047. files to  GNU  Texinfo,  run  Makeinfo  and  copy  the  Info  file  to
  1048. $INFOPATH.  You  have  to  edit $INFOPATH/dir to get access to the UDO
  1049. Info files.
  1050.  
  1051. Furthermore you should make some scripts or aliase to simplify calling
  1052. UDO. The following script (named `'u2tex`') shows how to tell UDO that
  1053. he shall convert the source file to LaTeX):
  1054.  
  1055.      #!bin/sh
  1056.      udo --tex -o ! $*
  1057.  
  1058. You can make similar scripts for the other destination formats if  you
  1059. want. The UDO distribution already contains some scripts.
  1060.  
  1061. Hint for  users of Linux-SGML: My version doesn't contain all possible
  1062. entities. Just take a look ate the Linuxdoc-SGML FAQ in the middle  of
  1063. this documentation if Linuxdoc-SGML prints an error message.
  1064.  
  1065.  
  1066.  
  1067. ======================================================================
  1068. Chapter 5
  1069.  
  1070. Usage
  1071. ======================================================================
  1072.  
  1073. In this chapter you will get to know which options you have to pass to
  1074. the command line version and how to use the versions with a  graphical
  1075. user interface.
  1076.  
  1077.  
  1078. 5.1  Command line version
  1079. =========================
  1080.  
  1081. The command  line  version  can  be  used identically on any operating
  1082. system UDO is available for.
  1083.  
  1084.  
  1085. Name
  1086. ----
  1087.  
  1088. udo - convert files from UDO into different formats
  1089.  
  1090.  
  1091. Synopsis
  1092. --------
  1093.  
  1094. udo [-adDghHilmnpqrstvwWxy] source file
  1095. udo [-adDghHilmnpqrstvwWxy] -o destination file source file
  1096.  
  1097.  
  1098. Description
  1099. -----------
  1100.  
  1101. UDO converts files from the UDO format  into  Apple-QuickView,  ASCII,
  1102. HTML,  Texinfo,  Linuxdoc-SGML,  Manualpage,  Pure-C-Help,  Rich  Text
  1103. Format, ST-Guide, LaTeX, Turbo Vision Help or Windows Help.
  1104.  
  1105. Using the first method  UDO  prints  the  destination  format  to  the
  1106. standard  output  (STDOUT)  and  error  messages to the standard error
  1107. output (STDERR). Using the second method UDO  writes  the  destination
  1108. format  to  the destination file and error messages to a log file with
  1109. the suffix .ul?.
  1110.  
  1111. You have to pass single options to UDO: -al isn't the same as -a -l!
  1112.  
  1113. The name of the source file has to be the last option.
  1114.  
  1115.  
  1116. Options
  1117. -------
  1118.  
  1119.  -a, --ascii        The source file will be converted to ASCII.
  1120.  
  1121.  -D symbol          Set the symbol `symbol' which can be tested in the
  1122.                     source file with !ifset.
  1123.  
  1124.  -g, --helptag      The  source  file will  be converted to HP Helptag
  1125.                     SGML.
  1126.  
  1127.  -h, --html         The source file will be converted to HTML.
  1128.  
  1129.  -H, --hold         You have to press a key before UDO finishes.
  1130.  
  1131.  -i, --texinfo      The source file will be converted to GNU Texinfo.
  1132.  
  1133.  --lyx              The source file will be converted to LyX.
  1134.  
  1135.  -l, --no-logfile   When using the Option -o UDO doesn't  save  a  log
  1136.                     file.
  1137.  
  1138.  -m, --man          The source file will be converted to a manualpage.
  1139.  
  1140.  -n, --nroff        The source file will be converted to Nroff.
  1141.  
  1142.  -o F, --outfile F  UDO writes the output into the file named "F".
  1143.  
  1144.  -p, --pchelp       The source file will be converted to Pure C Help.
  1145.  
  1146.  -q, --quiet        UDO won't print anything to STDOUT or STDERR.
  1147.  
  1148.  -r, --rtf          The source file will be converted to RTF.
  1149.  
  1150.  -s, --stg          The source file will be converted to ST-Guide.
  1151.  
  1152.  -t, --tex          The source file will be converted to LaTeX.
  1153.  
  1154.  -v, --vision       The  source file will be converted to Turbo Vision
  1155.                     Help.
  1156.  
  1157.  -w, --win          The source file will be converted to Windows Help.
  1158.  
  1159.  -W, --no-warnings  Warnings will be suppressed. Error  messages  will
  1160.                     still be printed.
  1161.  
  1162.  -x, --linuxdoc     The  source  file will  be  converted to Linuxdoc-
  1163.                     SGML.
  1164.  
  1165.  -y, --no-hypfile   UDO doesn't save a file with syllabification hints
  1166.                     when using the option -o.
  1167.  
  1168.  --help             Outputs a help page and quits.
  1169.  
  1170.  --test             When  using  this option UDO won't save a destina-
  1171.                     tion file.
  1172.  
  1173.  --tree             When using this option UDO will save a  file  with
  1174.                     the  suffix .ut?. In this file you will see a tree
  1175.                     with all files your source file includes.
  1176.  
  1177.  --verbose          UDO will  print  some  status   information   wile
  1178.                     converting the source file.
  1179.  
  1180.  --version          Outputs version information and quits UDO.
  1181.  
  1182.  
  1183. Examples
  1184. --------
  1185.  
  1186.  udo file.u
  1187.      Convert the source file `file.u' to ASCII (default) and print the
  1188.      output to the standard output and error messages to the  standard
  1189.      error output.
  1190.  
  1191.  udo --tex -o output.tex file.u
  1192.      Convert the source file `file.u' to LaTeX and write the output to
  1193.      the  file  named  `output.tex'.  Warnings,  error  messages   and
  1194.      additional  information  will  be  written  to the log file named
  1195.      `output.ult'.
  1196.  
  1197.  udo -s -y -l -o ! file.u
  1198.      Convert the source file `file.u' to ST-Guide and write the output
  1199.      to  `file.stg'. UDO won't save a log file or a file with syllabi-
  1200.      fication patterns.
  1201.  
  1202.  
  1203. Environment
  1204. -----------
  1205.  
  1206.  HOME         UDO looks for the file udo.ini in your home directory if
  1207.               UDOPATH doesn't exist.
  1208.  
  1209.  LANG         Sets  the  language  UDO shall use for error messages if
  1210.               neither LC_ALL nor LC_MESSAGES exists.
  1211.  
  1212.  LC_ALL       If this is set to `german' UDO prints  German  messages.
  1213.               If  this  variable  doesn't  exist LC_MESSAGES it tested
  1214.               instead.
  1215.  
  1216.  LC_MESSAGES  See LC_ALL. If this variable doesn't exist, too, LANG is
  1217.               tested instead.
  1218.  
  1219.  UDOPATH      UDO looks  for the file udo.ini in the directory defined
  1220.               by  this  variable.  If  UDOPATH doesn't  exist  HOME is
  1221.               tested instead.
  1222.  
  1223.  
  1224. Exit Status
  1225. -----------
  1226.  
  1227.  0   Everything was OK.
  1228.  >0  An error has appeared.
  1229.  
  1230.  
  1231. Author
  1232. ------
  1233.  
  1234. Copyright (c) 1995, 1996, 1997 by
  1235. Dirk Hagedorn (Dirk Hagedorn @ MK2, DirkHage@aol.com)
  1236.  
  1237.  
  1238. 5.2  GEM version
  1239. ================
  1240.  
  1241. The GEM  version  enables  you  to set the files and options by simply
  1242. clicking the mouse. Furthermore you can define  programs  for  editing
  1243. and viewing files that can be started by the GEM version.
  1244.  
  1245. The GEM  version  supports  the VA protocoll, iconification and drag &
  1246. drop. It runs with every AES: TOS, MultiTOS, Geneva, MagiC (Mac/PC) or
  1247. STonX.
  1248.  
  1249. While converting you can see the current status of UDO. Because of the
  1250. AES calls the GEM version runs slower than the  TTP  version.  If  you
  1251. want to convert large source files I recommend to use the TTP version.
  1252.  
  1253. The usage of the GEM version is very easy.
  1254.  
  1255.  
  1256. 5.2.1  GEM main dialog
  1257. ----------------------
  1258.  
  1259. In the  main dialog you can see several buttons and a menu bar. In the
  1260. main dialog you choose the source file, the destination file  and  the
  1261. destination  format.  By  pressing  the "Convert" button you start the
  1262. conversion.
  1263.  
  1264. The items of the menu bar open other dialogs in most cases. If not you
  1265. can  guess the sense of them by simply reading the menu item text. Two
  1266. menu items have to be described:
  1267.  
  1268.  Dest/Start program: You can define a  program  for  each  destination
  1269.                      format.  E.g.  you  can  define  a  program  that
  1270.                      converts the ST-Guide  source  files  (made  with
  1271.                      UDO) into a ST-Guide hypertext, or a program that
  1272.                      converts the LaTeX files into a DVI file.
  1273.  
  1274.  Dest/ST-Guide:      If you choose this menu item UDO  calls  the  ST-
  1275.                      Guide  and  tells  it  to  display  the converted
  1276.                      hypertext (source file name, suffix `.hyp)').
  1277.  
  1278.  
  1279. 5.2.2  GEM dialog `Settings'
  1280. ----------------------------
  1281.  
  1282. After clicking the menu item "Options, Settings" this dialog  appears.
  1283. The  sense of each button you can see in this dialog will be described
  1284. now.
  1285.  
  1286.    ⁿ Destination file:
  1287.  
  1288.         - Adjust: If this button  is  checked  the  GEM  version  will
  1289.           adjust  the  file name of the destination file when changing
  1290.           the destination format. How it is adjusted  depends  on  the
  1291.           status of the following buttons:
  1292.  
  1293.              * Completely: UDO adjusts the name completely.
  1294.  
  1295.              * Name  and suffix: UDO takes the name of the source file
  1296.                and adjusts the suffix according to the current  desti-
  1297.                nation  format.  The path of the destination file isn't
  1298.                adjusted.
  1299.  
  1300.              * Only the suffix: UDO adjusts only  the  suffix  of  the
  1301.                destination  file  according to the current destination
  1302.                format. The path and the file name aren't adjusted.
  1303.  
  1304.         - View: If this button is checked UDO will call  the  destina-
  1305.           tion viewer after having converted the source file.
  1306.  
  1307.    ⁿ Ask before:
  1308.  
  1309.         - Quitting  UDO: If this button is checked UDO asks you before
  1310.           quitting it.
  1311.  
  1312.         - Overwriting file:If the destination file already exists  UDO
  1313.           will  ask  if it should overwrite the file when starting the
  1314.           conversion.
  1315.  
  1316.    ⁿ Options:
  1317.  
  1318.         - Save log file: Shall UDO save a log file that  contains  all
  1319.           error  messages, warning messages and additional information
  1320.           (similar to the command line option --no-logfile)?
  1321.  
  1322.         - Save hyphen file: Shall UDO save a hyphen file with syllabi-
  1323.           fication patterns (similar to the command line option --no-
  1324.           hypfile)?
  1325.  
  1326.         - Save tree file: Shall UDO save a tree file where you can see
  1327.           the include file structure of your documentation (similar to
  1328.           the command line option --treefile)?
  1329.  
  1330.         - Verbose  mode:  Shall  UDO  display  the  status  during the
  1331.           conversion (similar to the command line option --verbose)?
  1332.  
  1333.         - Suppress warnings: Shall UDO suppress  warning  messages  in
  1334.           the log file (similar to the command line option --no-
  1335.           warnings)?
  1336.  
  1337.  
  1338. 5.2.3  GEM dialog `Symbols'
  1339. ---------------------------
  1340.  
  1341. The GEM  version  enables  you to set predefined symbols when starting
  1342. the conversion. You can insert the text and choose which symbol has to
  1343. be used by clicking the buttons on the left side.
  1344.  
  1345. If an entry is checked UDO will use the text as a predefined symbol.
  1346.  
  1347.  
  1348. 5.2.4  GEM dialog `External programs'
  1349. -------------------------------------
  1350.  
  1351. This dialog  looks  very  complicated  and  I  must say that I have to
  1352. change the design next time.
  1353.  
  1354. In this dialog you can define the programs you can use for editing and
  1355. viewing  the  source files and destination files or for converting the
  1356. destination files.
  1357.  
  1358. Please select the destination format in the upper half.
  1359.  
  1360. In the lower half you can choose the program. If this program isn't  a
  1361. GEM  application you should check the button "TOS program". If it is a
  1362. GEM  application  and  it  supports  VA_START you  should  check   the
  1363. "Supports VA_START" button. These settings are only used if UDO starts
  1364. the programs itself. Finally you can edit the parameters UDO shall use
  1365. when  calling  the  programs. You can use placeholders for the name of
  1366. the current source file and destination file. Click the "Hint"  button
  1367. to get more information.
  1368.  
  1369.  
  1370. How UDO starts programs
  1371.  
  1372.    ⁿ In first place UDO will look for an AV server. If AVSERVER is set
  1373.      inside the environment or Gemini or Thing are running, UDO  tells
  1374.      them to start the program.
  1375.  
  1376.    ⁿ If there's no AV server available UDO starts the programs itself.
  1377.  
  1378.         - If  the  program  is  an  accessory  the  parameters will be
  1379.           transferred via VA_START.
  1380.  
  1381.         - If the program is already running and it supports  VA_START,
  1382.           UDO will send a VA_START message to this program.
  1383.  
  1384.         - In  all  other  cases  UDO  will start GEM applications with
  1385.           shel_write() and TOS programs with Pexec().
  1386.  
  1387.  
  1388. 5.3  Macintosh version
  1389. ======================
  1390.  
  1391. The macintosh version looks more simply  than  the  GEM  version.  All
  1392. available options are combined in one dialog.
  1393.  
  1394. If you  don't  start  it with passing a UDO source file you can choose
  1395. one by clicking the [Choose] or [Auswכhlen] button. You  can  set  the
  1396. destination  format  by  using  one  of the available formats that are
  1397. listed inside the popup. If the destination files shouldn't  be  saved
  1398. in  the  source folder you can choose a destination folder by clicking
  1399. the second [Choose] or [Auswכhlen] button.
  1400.  
  1401. Which files UDO will save  you  can  define  by  using  the  group  of
  1402. buttons.  I  hope you can guess the function of each button by reading
  1403. the labels. The setting of the display popup  ("Ausgabeanzeige")  sets
  1404. the  speed  of  UDO. If you set it to "cooperative" ("kooperativ") you
  1405. can work with other applications while UDO is  converting  the  source
  1406. file.
  1407.  
  1408. The conversion  can  be started by clicking the [Output] or [Ausgeben]
  1409. button. If your source  file  doesn't  contain  any  error  UDO  quits
  1410. without  any  comment.  If  there  were  errors  the Macintosh version
  1411. presents an error message with link to the log file.
  1412.  
  1413. After having paid the  shareware  fee  you  will  get  a  personalized
  1414. keycode  that  you can enter into the dialog. If you enter the keycode
  1415. correctly all limitations of the shareware version will be disabled.
  1416.  
  1417. The documentation of UDO can be displayed anytime by pressing the help
  1418. key  or  clicking  the  help  menu if you have installed the hypertext
  1419. viewer Hyperion (written  by  Martin  Osieka)  and  if  the  hypertext
  1420. UDO.HYP is installed in the guides folder of Hyperion.
  1421.  
  1422.  
  1423. 5.4  UDO Shell for Windows
  1424. ==========================
  1425.  
  1426. The UDO shell for Windows ("UDOSH") makes it easier for you to use UDO
  1427. with Windows.
  1428.  
  1429. The shell can call UDO, editors and viewers and you can simple  choose
  1430. which destination format you want to use by clicking the mouse.
  1431.  
  1432. The shell is distributed with the complete source code for Borland C++
  1433. and is described in a separate documentation.
  1434.  
  1435.  
  1436.  
  1437. ======================================================================
  1438. Chapter 6
  1439.  
  1440. The syntax of UDO
  1441. ======================================================================
  1442.  
  1443.  
  1444. 6.1  A short example
  1445. ====================
  1446.  
  1447. Before going into details I want to show you how an  UDO  source  file
  1448. may  look like. You can use this example to make your own source files
  1449. if you want to.
  1450.  
  1451.      -----------------------------------------------------------------
  1452.  
  1453.      ########################################
  1454.      # @(#) An example for UDO
  1455.      # @(#) Dirk Hagedorn, 1996/04/16
  1456.      ########################################
  1457.      
  1458.      !stg @subject "Documentation/Utilities"
  1459.      
  1460.      !title   A short example for
  1461.      !program UDO
  1462.      !date    (!today)
  1463.      !author  Dirk Hagedorn
  1464.      
  1465.      !use_auto_subtocs    [info,html,stg,tvh,win,aqv]
  1466.      !use_auto_subsubtocs [info,html,stg,tvh,win,aqv]
  1467.      !no_effects          [asc]
  1468.      !use_justified       [asc]
  1469.      
  1470.      ########################################
  1471.      
  1472.      !begin_document
  1473.      !maketitle
  1474.      !tableofcontents
  1475.      
  1476.      !node Automatic layout
  1477.      
  1478.      UDO layouts the source file automatically. You don't have
  1479.      to take care about spaces between
  1480.      two                           words
  1481.      because UDO enters line breaks on its own.
  1482.      
  1483.      
  1484.      
  1485.      Further more it doesn't make sense but doesn't disturb UDO
  1486.      if you enter more than one empty line between to
  1487.      paragraphs.
  1488.      
  1489.      Paragraphs are split by using empty lines or commands.
  1490.      
  1491.      
  1492.      !node A chapter
  1493.      This is the text of this chapter.
  1494.      
  1495.      Due to the switches inside the preamble it follows a
  1496.      table-of-contents-like list of all sections of this chapter.
  1497.      
  1498.      !subnode A section
  1499.      This is the text of this section. A ""subsubtoc"" will
  1500.      follow due to the switches inside the preamble, too.
  1501.      
  1502.      !subsubnode A subsection
  1503.      This is the text of this subsection.
  1504.      
  1505.      !end_document
  1506.  
  1507.      -----------------------------------------------------------------
  1508.  
  1509.  
  1510. Explanations
  1511. ------------
  1512.  
  1513. At the beginning of this example you can see a comment. A comment is a
  1514. line that begins with a `#' immediately.
  1515.  
  1516. The next  line is a special line. This line contains a special command
  1517. for the ST-Guide. If you don't know the ST-Guide just add this line at
  1518. the  beginning of your source file so that are all the people are able
  1519. to build a hypertext if they want to.
  1520.  
  1521. Now the information for the title page  and  the  headlines  are  set.
  1522. !title and  !program should  make  sense  if  you  read them one after
  1523. another. In this example it would be "An example for UDO". If you look
  1524. at  the  line  containing  !date you will see the placeholder (!today)
  1525. that is replaced by the current system  date.  You  can  set  !date to
  1526. April 16th, 1996 manually, if you want to.
  1527.  
  1528. The preamble contains some switches. The first to switches are set for
  1529. the output of "sub-tables-of-contents" in  hypertexts.  The  abbrevia-
  1530. tions  of  these  hypertexts  you  will  see inside the brackets. In a
  1531. "subtoc" all subnodes of a node are printed like a table  of  contents
  1532. so  that  readers  of a hypertext are enabled to directly switch to an
  1533. interesting subnode.
  1534.  
  1535. The switch !no_effects  [asc] suppresses  the  usage  of  Usenet  text
  1536. effect commands like stars for bold and slashes for italic text.
  1537.  
  1538. The switch  !use_justified  [asc] tells  UDO  to layout the ASCII file
  1539. with justified text.
  1540.  
  1541. The command !begin_document tells UDO that now the main  part  of  the
  1542. document begins. This command has to be part of any source file!
  1543.  
  1544. In first  place  we  output  the  title  page  that  is built with the
  1545. information set in the  preamble  of  this  example.  You  should  use
  1546. !maketitle directly after !begin_document if you use it. It's possible
  1547. to use it later but I don't think that it would work without problems.
  1548.  
  1549. Then we want that UDO prints a table of contents. There  you  can  see
  1550. all  chapters,  sections  and  subsections  of  the  source file. Like
  1551. !maketitle you    should    use    !tableofcontents directly     after
  1552. !begin_document or !maketitle if you use this command.
  1553.  
  1554. Now we  can  enter  the first chapter of our text. Chapters are marked
  1555. with !node. Please read the contents of  this  chapter  that  contains
  1556. additional information.
  1557.  
  1558. The following  lines  demonstrate  how  to  use chapters, sections and
  1559. subsections. You should also read the text of these  chapters  to  get
  1560. more information.
  1561.  
  1562. Finally we  end  our text with the command !end_document. This command
  1563. has to be part of every source file and should be the last command  of
  1564. a source file!
  1565.  
  1566.  
  1567. 6.2  Basics
  1568. ===========
  1569.  
  1570.  
  1571. 6.2.1  Let's talk about text, Baby!
  1572. -----------------------------------
  1573.  
  1574. UDO expects a text file that you can edit with every ASCII editor. You
  1575. should use only printable characters. That means you shouldn't use any
  1576. characters  below  "space"  except ASCII 9 (tab), ASCII 10 (line feed)
  1577. and ASCII 13 (carriage return). A line  of  a  source  file  shouldn't
  1578. contain more than 512 characters.
  1579.  
  1580. UDO layouts  the  destination file itself. That means that it fills in
  1581. spaces between words and lines between paragraphs:
  1582.  
  1583.  Words are characters that are divided by one or more  blank  or  tab.
  1584.      UDO prints words divided by one blank.
  1585.  
  1586.  Paragraphs consist  of  words.  Paragraphs are divided by one or more
  1587.      empty line(s) or UDO commands.  UDO  divides  paragraphs  by  one
  1588.      empty line when printing the destination file.
  1589.  
  1590. You can compose the source file using different charsets. UDO supports
  1591. the following character sets:
  1592.  
  1593.    ⁿ Atari ST (!code_tos)
  1594.    ⁿ Apple Macintosh (!code_mac)
  1595.    ⁿ HP Roman 8 (!code_hp8)
  1596.    ⁿ IBM PC (!code_dos)
  1597.    ⁿ ISO Latin 1, Windows ANSI (!code_iso)
  1598.  
  1599. When UDO starts the conversion it excepts the character  set  that  is
  1600. used  on  the  current operating system. If you want to convert source
  1601. files that use characters from a different operating system  you  have
  1602. to  tell it to UDO by using the upper commands. Additional information
  1603. can be found in the chapter "Special characters".
  1604.  
  1605.  
  1606. 6.2.2  Commands, switches and placeholders
  1607. ------------------------------------------
  1608.  
  1609.  Commands:     An  UDO  command  begins  with  a  single  "!"  at  the
  1610.                beginning  of  a  line, it may be indented by spaces or
  1611.                tabs. A command tells UDO to  do  something  where  you
  1612.                used  it  e.g.  to  output  the  table of contents with
  1613.                !tableofcontents.
  1614.  
  1615.  Switches:     An UDO switch begins with a single "!" at the beginning
  1616.                of  a  line,  it  may  be indented by spaces or tabs. A
  1617.                switch tells UDO  how  to  handle  some  commands  e.g.
  1618.                !language  english that  switches  the  language of the
  1619.                destination file to English  so  that  UDO  will  print
  1620.                "Appendix" instead of "Anhang".
  1621.  
  1622.  Placeholders: An  UDO  placeholder begins with a "(!" and ends with a
  1623.                single ")". A placeholder is replaced by certain  char-
  1624.                acters  e.g.  `(!B)'  by  `{\bf' for LaTeX. You can use
  1625.                placeholders wherever you want.
  1626.  
  1627.  
  1628. 6.2.3  Comments
  1629. ---------------
  1630.  
  1631. A source file can contain comments. UDO ignores a line  if  the  first
  1632. character  of  a  line is a `#'. This character mustn't be indented by
  1633. spaces or tabs!
  1634.  
  1635. Inside a verbatim  environment  or  raw  environment  you  cannot  use
  1636. comments because UDO prints every line of such an environment.
  1637.  
  1638.  
  1639. 6.2.4  Preamble and main part
  1640. -----------------------------
  1641.  
  1642. Each source file has to contain a preamble and a main part.
  1643.  
  1644. In the  preamble  you define general information about the source file
  1645. like information for the title page or the switches that tell UDO  how
  1646. to  convert  the  source  file.  The  preamble  ends  with the command
  1647. !begin_document.
  1648.  
  1649. The main part contains the text structured into chapters, sections  or
  1650. subsections. The main part ends with the command !end_document.
  1651.  
  1652.  
  1653. 6.2.5  Environments
  1654. -------------------
  1655.  
  1656. An environment  is a part of a source file that has to be converted in
  1657. a special way. Environments will be started with !begin_ and  finished
  1658. with  !end_.  The  commands have to be the first words of a line. They
  1659. may be indented by spaces or tabs.
  1660.  
  1661. UDO offers you a large range of environments that  will  help  you  to
  1662. layout your text and to insert special commands:
  1663.  
  1664.  appendix environment:    appendix
  1665.  center environment:      centred text
  1666.  description environment: descriptions
  1667.  document environment:    documentation contents
  1668.  enumerate environment:   enumerations
  1669.  flushleft environment:   left justified text
  1670.  flushright environment:  right justified text
  1671.  itemize environment:     itemizations
  1672.  quote environment:       indented text
  1673.  raw environment:         special commands for the destination format
  1674.  table environment:       tables
  1675.  verbatim environment:    preformatted text
  1676.  xlist environment:       lists
  1677.  
  1678. How the  text  of  an  environment  is  formatted  you can find in the
  1679. according sections.
  1680.  
  1681.  
  1682. 6.3  Structuring
  1683. ================
  1684.  
  1685. In this chapter you will get to know  what  commands  are  offered  to
  1686. structure your documentation.
  1687.  
  1688.  
  1689. 6.3.1  Title page
  1690. -----------------
  1691.  
  1692. Using the command !maketitle you can tell UDO to generate a title page
  1693. built with information you set in  the  preamble  with  the  following
  1694. commands:
  1695.  
  1696.  !title:       The  title  of the documentation e.g. "The guide to" or
  1697.                "The introduction to".
  1698.  !program:     The name of the software or theme you  describe  inside
  1699.                the documentation.
  1700.  !programimage: The  filename  of  an  image  UDO shall display on the
  1701.                title page instead of !program.
  1702.  !version:     This is used for version information e.g.  "Release  6"
  1703.                or "Version 42".
  1704.  !date:        The  date  you  have  written  the documentation or the
  1705.                program.
  1706.  !author:      The name of the author of the documentation.
  1707.  !authorimage: The filename of an image UDO shall display on the title
  1708.                page above the name of the author.
  1709.  !street:      The  street  where the author lives. Optionally you can
  1710.                enter any other text that will be displayed  below  the
  1711.                name of the author on the title page.
  1712.  !town:        The  town  where  the  author lives. Optionally you can
  1713.                enter any other text that will be displayed  below  the
  1714.                street on the title page.
  1715.  !country:     The  country where the author lives. Optionally you can
  1716.                enter any other text that will be displayed  below  the
  1717.                town on the title page.
  1718.  !email:       The  email  address(es) of the author. You can use this
  1719.                command up to five  time  if  you  have  several  email
  1720.                addresses.
  1721.  
  1722. You don't  have  to use all commands but you should use one command at
  1723. least if you are using the command !maketitle.
  1724.  
  1725. When used   !maketitle should   only   be    used    directly    after
  1726. !begin_document.  To  use  this command at another place of the source
  1727. file is allowed but there could be problems.
  1728.  
  1729. The title page will be printed on a single  page  when  converting  to
  1730. ST-Guide  or  Windows Help. This is a great help for people with small
  1731. screens. From the title page you will be able to jump to the table  of
  1732. contents.
  1733.  
  1734. Converting to  LaTeX  UDO generates a single page using the title page
  1735. environment built with the information from the preamble.
  1736.  
  1737. If you want to make your own title page you have to use  some  tricks.
  1738. You  will  find  an example inside the UDO distribution that shows you
  1739. how to make userdefined title pages.
  1740.  
  1741.  
  1742. 6.3.2  Tables of contents
  1743. -------------------------
  1744.  
  1745. Using the command !tableofcontents you can  tell  UDO  to  generate  a
  1746. table of contents that lists all chapters, sections and subsections of
  1747. the source file.
  1748.  
  1749. You should   use   !tableofcontents directly    after    !maketitle or
  1750. !begin_document to avoid problems.
  1751.  
  1752. By using   the   switches   !no_toc_subnodes,  !no_toc_subsubnodes and
  1753. !no_toc_subsubsubnodes you can decrease  the  size  of  the  table  of
  1754. contents. This is useful when writing large hypertexts.
  1755.  
  1756. If you  want  to  list  all  sections of a chapter, all subsections of
  1757. section or all paragraphs of a  subsection  you  can  output  this  so
  1758. called  "sub-table  of  contents"  with  the  commands called !subtoc,
  1759. !subsubtoc and !subsubsubtoc. This is useful for hypertexts where  you
  1760. then have the possibility to switch directly to an interesting section
  1761. or subsection. UDO enables you  to  automatize  the  output  of  these
  1762. "subtoc's"  using the switches !use_auto_subtocs, !use_auto_subsubtocs
  1763. and !use_auto_subsubsubtocs.
  1764.  
  1765. If you use the upper switches to print subtocs automatically  but  you
  1766. don't  want  to  print  them  in  specific chapters you can insert the
  1767. commands !ignore_subtoc, !ignore_subsubtoc or !ignore_subsubsubtoc. If
  1768. a  chapter  contains  one  of  these commands there will be printed no
  1769. table of contents neither automatically nor manually by using  !subtoc
  1770. etc.
  1771.  
  1772.  
  1773. Summary of all commands and switches
  1774. ------------------------------------
  1775.  
  1776.  !tableofcontents:       Prints  the  table  of contents on a separate
  1777.                          page.
  1778.  !toc:                   Prints the table of contents inside the text.
  1779.  !subtoc:                Prints all sections of a chapter.
  1780.  !subsubtoc:             Prints all subsections of a section.
  1781.  !subsubsubtoc:          Prints all paragraphs of a subsection.
  1782.  !no_toc_subnodes:       Tells UDO that  it  has  to  print  only  the
  1783.                          chapter names inside the table of contents.
  1784.  !no_toc_subsubnodes:    The table of contents lists only the chapters
  1785.                          and sections.
  1786.  !no_toc_subsubsubnodes: The  table  of  contents   lists   only   the
  1787.                          chapters, sections and subsections.
  1788.  !use_auto_subtocs:      Print    all    sections    of    a   chapter
  1789.                          automatically.
  1790.  !use_auto_subsubtocs:   Print   all   subsections   of   a    section
  1791.                          automatically.
  1792.  !use_auto_subsubsubtocs: Print   all   paragraphs   of  a  subsection
  1793.                          automatically.
  1794.  !ignore_subtoc:         Don't  print  the  sections  of  the  current
  1795.                          chapter.
  1796.  !ignore_subsubtoc:      Don't  print  the  subsections of the current
  1797.                          section.
  1798.  !ignore_subsubsubtoc:   Don't print the  paragraphs  of  the  current
  1799.                          subsection.
  1800.  
  1801. Please note:
  1802.  
  1803.   1. When  converting to HTML the title page and the table of contents
  1804.      will be printed in the file you passed via the command line.
  1805.  
  1806.   2. When converting to RTF no table of contents  will  be  generated!
  1807.      You  should  make  this with the functions of your text processor
  1808.      that is used to import the converted RTF file.
  1809.  
  1810.  
  1811. 6.3.3  Chapters, sections, subsections and paragraphs
  1812. -----------------------------------------------------
  1813.  
  1814. UDO offers you four layers for structuring your  documentation.  These
  1815. layers are called chapters, sections, subsections and paragraphs.
  1816.  
  1817. Using the command !node you tell UDO that a new chapter begins and you
  1818. tell it how the chapter is named. The commands  !subnode,  !subsubnode
  1819. and   !subsubsubnode do   the  same  for  a  section,  subsection  and
  1820. paragraph.
  1821.  
  1822. Watch this example (without text) to understand what I want to say:
  1823.  
  1824.      !node          A chapter
  1825.      !subnode       A section
  1826.      !subsubnode    A subsection
  1827.      !subsubsubnode A paragraph
  1828.      !node          And a different chapter
  1829.  
  1830. The table of contents should look like this:
  1831.  
  1832.      1  A chapter
  1833.         1.1  A section
  1834.              1.1.1  A subsection
  1835.                     1.1.1.1  A Paragraph
  1836.      
  1837.      2  And a different chapter
  1838.  
  1839. Windows Help and ST-Guide may display text in dialog boxes, too. These
  1840. so called popup nodes can be used with the following commands:
  1841.  
  1842.    ⁿ !pnode for popup chapters,
  1843.    ⁿ !psubnode for popup sections,
  1844.    ⁿ !psubsubnode for popup subsections and
  1845.    ⁿ !psubsubsubnode for popup paragraphs
  1846.  
  1847. Furthermore you  can create chapters that don't appear in the table of
  1848. contents. Use these commands...
  1849.  
  1850.    ⁿ !node* for chapters,
  1851.    ⁿ !subnode* for sections,
  1852.    ⁿ !subsubnode* for subsections,
  1853.    ⁿ !subsubsubnode* for paragraphs
  1854.    ⁿ !pnode* for popup chapters,
  1855.    ⁿ !psubnode* for popup sections,
  1856.    ⁿ !psubsubnode* for popup subsections and
  1857.    ⁿ !psubsubsubnode* for popup paragraphs.
  1858.  
  1859. Please note:
  1860.  
  1861.   1. Chapters that aren't listed  in  the  table  of  contents  aren't
  1862.      numbered, too. UDO will create hypertext links to them as it does
  1863.      for all other chapters.
  1864.  
  1865.   2. UDO enumerates the chapters automatically. If you want to display
  1866.      the  chapter  names  without  numbers  you  can  use  the  switch
  1867.      !no_numbers inside the preamble.
  1868.  
  1869.  
  1870. 6.3.4  Appendix
  1871. ---------------
  1872.  
  1873. UDO can manage one(!) appendix. The contents of the appendix has to be
  1874. used inside the appendix environment. This environment is started with
  1875. !begin_appendix and finished with !end_appendix.
  1876.  
  1877. Chapters that are part of the appendix are  enumerated  using  letters
  1878. instead of numbers. A short example:
  1879.  
  1880.      !node  A chapter outside the appendix
  1881.      !begin_appendix
  1882.      !node           A chapter
  1883.      !subnode        A section
  1884.      !subsubnode     A subsection
  1885.      !subsubsubnode  A paragraph
  1886.      !end_appendix
  1887.  
  1888. The table of contents should look like this:
  1889.  
  1890.      5  A chapter outside the appendix
  1891.      
  1892.      Appendix
  1893.      
  1894.      A  A chapter
  1895.         A.1  A section
  1896.              A.1.1  A subsection
  1897.                     A.1.1.1  A paragraph
  1898.  
  1899. Please note:
  1900.  
  1901.   1. You  should  use  the appendix at the end of your source file. In
  1902.      other words !end_appendix should be  the  last  but  one  command
  1903.      before  !end_document.  You shouldn't use any additional chapters
  1904.      behind !end_appendix because UDO  will  get  confused  especially
  1905.      while enumerating the chapters.
  1906.  
  1907.   2. Because  UDO  uses  letters  for  creating  the  numbers  for the
  1908.      chapters of the appendix you shouldn't use more than 26  chapters
  1909.      inside the appendix.
  1910.  
  1911.  
  1912. 6.4  Emphasising text
  1913. =====================
  1914.  
  1915. In this  section  you  will  get  to  know  how  to layout passages in
  1916. different ways. UDO supports centred, left justified, right  justified
  1917. and   indented  text,  different  kinds  of  lists,  environments  for
  1918. preformatted text and tables. Furthermore you can use  different  text
  1919. styles and footnotes.
  1920.  
  1921.  
  1922. 6.4.1  Itemizations
  1923. -------------------
  1924.  
  1925. You can  use  the  itemize  environment  for  itemizations where every
  1926. single item is marked with a bullet, star, dash or point. The  itemize
  1927. environment   is   started   with   !begin_itemize and  finished  with
  1928. !end_itemize. Each item has to be marked with the !item command.
  1929.  
  1930. You can use the  itemize  environment  inside  other  environments  or
  1931. inside another itemize environment.
  1932.  
  1933. This short example shows how to write a simple itemize environment:
  1934.  
  1935.      !begin_itemize
  1936.      !item This is the first item.
  1937.      !item This is the second item with a little bit
  1938.            more text to demonstrate how UDO formats
  1939.            an itemization.
  1940.      
  1941.            This is the second paragraph of the
  1942.            second item of the itemize environment.
  1943.      !item This is the last item.
  1944.      !end_itemize
  1945.  
  1946. ... will be printed this way:
  1947.  
  1948.    ⁿ This is the first item.
  1949.  
  1950.    ⁿ This  is  the  second  item with a little bit more text to demon-
  1951.      strate how UDO formats an itemization.
  1952.  
  1953.      This is the second paragraph of the second item  of  the  itemize
  1954.      environment.
  1955.  
  1956.    ⁿ This is the last item.
  1957.  
  1958. And this  example, where an itemize environment is used inside another
  1959. one ...
  1960.  
  1961.      !begin_itemize
  1962.      !item This is the first item of the outer
  1963.            itemize environment.
  1964.      !item This is the second item of the outer
  1965.            itemize environment.
  1966.            !begin_itemize
  1967.            !item This is the 1st item of the inner one.
  1968.            !item This is the 2nd item of the inner one.
  1969.            !end_itemize
  1970.      !item This is the third item of the outer
  1971.            itemize environment.
  1972.      !end_itemize
  1973.  
  1974. ... will be printed this way:
  1975.  
  1976.    ⁿ This is the first item of the outer itemize environment.
  1977.  
  1978.    ⁿ This is the second item of the outer itemize environment.
  1979.  
  1980.         - This is the 1st item of the inner one.
  1981.  
  1982.         - This is the 2nd item of the inner one.
  1983.  
  1984.    ⁿ This is the third item of the outer itemize environment.
  1985.  
  1986.  
  1987. UDO separates the text of each item by an empty line.  In  some  cases
  1988. it's  not  a  good idea to separate the items e.g. if an item contains
  1989. only some text. In this case it would be better to suppress the  empty
  1990. lines to get a compressed environment.
  1991.  
  1992. For printing  compressed  environment UDO offers you the command named
  1993. !short you can add to the !begin_itemize command. If  you  add  !short
  1994. UDO  won't separate the items by inserting empty lines. Furthermore in
  1995. all environments you use inside  this  itemize  environment  no  empty
  1996. lines will be printed.
  1997.  
  1998. The following  two  examples  show  how  to use the !short command and
  1999. which effects this command has. The first example doesn't, the  second
  2000. one uses !short:
  2001.  
  2002. Without !short...
  2003.  
  2004.      !begin_itemize
  2005.      !item Item 1
  2006.      !item Item 2
  2007.      !item Item 3
  2008.      !end_itemize
  2009.  
  2010. ... will be displayed this way:
  2011.  
  2012.    ⁿ Item 1
  2013.  
  2014.    ⁿ Item 2
  2015.  
  2016.    ⁿ Item 3
  2017.  
  2018. With !short...
  2019.  
  2020.      !begin_itemize !short
  2021.      !item Item 1
  2022.      !item Item 2
  2023.      !item Item 3
  2024.      !end_itemize
  2025.  
  2026. ... will be displayed this way:
  2027.  
  2028.    ⁿ Item 1
  2029.    ⁿ Item 2
  2030.    ⁿ Item 3
  2031.  
  2032. If you  can't  see any difference the destination format doesn't allow
  2033. it to suppress the item separation.
  2034.  
  2035.  
  2036. Please note:
  2037.  
  2038.   1. The items of the first itemize environment will be marked with  a
  2039.      bullet   that  is  defined  on  different  positions  inside  the
  2040.      character set of each operating system.
  2041.  
  2042.   2. If you use the switch  !no_umlaute inside  the  preamble  of  the
  2043.      source  file  the  items of the first itemize environment will be
  2044.      marked with an `o' instead of a bullet.
  2045.  
  2046.  
  2047. 6.4.2  Enumerations
  2048. -------------------
  2049.  
  2050. The enumerate environment is useful for lists where the items have  to
  2051. be   enumerated   with   numbers   or  letters.  It  is  started  with
  2052. !begin_enumerate and finished with !end_enumerate. Each item has to be
  2053. marked with !item.
  2054.  
  2055. You can  use  the  itemize  environment  inside  other environments or
  2056. inside another itemize environment.
  2057.  
  2058. This short example shows how to write a simple itemize environment:
  2059.  
  2060.      UDO offers you the following environments:
  2061.      !begin_enumerate
  2062.      !item itemize environment
  2063.      !item enumerate environment (discussed in
  2064.            this section)
  2065.      !item description environment
  2066.      !item xlist environment
  2067.      !end_enumerate
  2068.  
  2069. ... will be displayed this way:
  2070.  
  2071. UDO offers you the following environments:
  2072.  
  2073.   1. itemize environment
  2074.  
  2075.   2. enumerate environment (discussed in this section)
  2076.  
  2077.   3. description environment
  2078.  
  2079.   4. xlist environment
  2080.  
  2081. In the following example the enumerate environment is used  twice  and
  2082. it will be compressed because of the usage of !short:
  2083.  
  2084.      !begin_enumerate !short
  2085.      !item This is the first item of the outer
  2086.            enumerate environment.
  2087.      !item This is the second item of the outer
  2088.            enumerate environment.
  2089.            !begin_enumerate
  2090.            !item Item 1 of the inner environment.
  2091.            !item Item 2 of the inner environment.
  2092.            !end_enumerate
  2093.      !item This is the third item of the outer
  2094.            enumerate environment.
  2095.      !end_enumerate
  2096.  
  2097. ... becomes to:
  2098.  
  2099.   1. This is the first item of the outer enumerate environment.
  2100.   2. This is the second item of the outer enumerate environment.
  2101.       (a) Item 1 of the inner environment.
  2102.       (b) Item 2 of the inner environment.
  2103.   3. This is the third item of the outer enumerate environment.
  2104.  
  2105. Please note:
  2106.  
  2107.   1. UDO doesn't enumerate the items for all destination formats. E.g.
  2108.      HTML and LaTeX enumerate the items themselves so you have  to  be
  2109.      cautious with using text like "see item 1" or "see point b)".
  2110.  
  2111.   2. The third layer of enumerate environments will be indented deeper
  2112.      than the other layers because Roman numbers  need  a  little  bit
  2113.      more space.
  2114.  
  2115.   3. Because the second layer is enumerated with letters you shouldn't
  2116.      use more than 26 items.
  2117.  
  2118.   4. A description of  the  !short command  is  part  of  the  chapter
  2119.      "Itemizations".
  2120.  
  2121.  
  2122. 6.4.3  Descriptions
  2123. -------------------
  2124.  
  2125. Use the  description  environment for describing some words. Start the
  2126. environment    with    !begin_description and    finish    it    using
  2127. !end_description.
  2128.  
  2129. A word  that  has  to  be described is used with the !item [ ] command
  2130. inside brackets and will be displayed with bold text.
  2131.  
  2132. The description environment can be used inside other (description) en-
  2133. vironments. This example...
  2134.  
  2135.      UDO offers you the following environments:
  2136.      !begin_description
  2137.      !item [the itemize environment]
  2138.            for itemized lists,
  2139.      !item [the enumerate environment]
  2140.            for enumerated lists,
  2141.      !item [the description environment]
  2142.            for descriptions and
  2143.      !item [the xlist environment]
  2144.            for lists
  2145.      !end_description
  2146.  
  2147. ... will be display this way:
  2148.  
  2149. UDO offers you the following environments:
  2150.  
  2151.  the itemize environment for simple lists,
  2152.  
  2153.  the enumerate environment for enumerated lists,
  2154.  
  2155.  the description environment for descriptions and
  2156.  
  2157.  the xlist environment for lists
  2158.  
  2159. In this example the description environment is used inside another one
  2160. and the !short is used, too:
  2161.  
  2162.      !begin_description !short
  2163.      !item [Item 1] of the outer description environment
  2164.      !item [Item 2] of the outer description environment
  2165.            !begin_description
  2166.            !item [Item 1] of the inner environment.
  2167.            !item [Item 2] of the inner environment.
  2168.            !end_description
  2169.      !item [Item 3] of the outer description environment
  2170.      !end_description
  2171.  
  2172. ... becomes to:
  2173.  
  2174.  Item 1 of the outer description environment
  2175.  Item 2 of the outer description environment
  2176.       Item 1 of the inner environment.
  2177.       Item 2 of the inner environment.
  2178.  Item 3 of the outer description environment
  2179.  
  2180. Please note:
  2181.  
  2182.   1. If the word that shall be displayed in bold text contains  a  "]"
  2183.      you have to quote it with an exclamation mark to tell UDO that it
  2184.      has to be printed in bold text, too.
  2185.  
  2186.   2. The HTML version of your source file will print the  descriptions
  2187.      in  bold  text,  too, even if this not typical for HTML. The next
  2188.      versions of UDO will offer a command to  disable  the  bold  text
  2189.      inside descriptions for HTML.
  2190.  
  2191.   3. A  description  of  the  !short command  is  part  of the chapter
  2192.      "Itemizations".
  2193.  
  2194.  
  2195. 6.4.4  Lists
  2196. ------------
  2197.  
  2198. Like the description environment this set of  commands  is  useful  to
  2199. describe words. Using this environment the description of each word is
  2200. displayed beneath one another.
  2201.  
  2202. The xlist environment starts with !begin_xlist [...] and finishes with
  2203. !end_xlist. You have to tell UDO in brackets how wide it should indent
  2204. the descriptions of each item. Usually you use  the  longest  word  in
  2205. brackets.  Each  word  that has to be described has to used inside the
  2206. brackets of the !item [ ] command.
  2207.  
  2208. You can use the xlist environment inside other  (xlist)  environments,
  2209. too.
  2210.  
  2211. This short example...
  2212.  
  2213.      UDO offers you the following environments:
  2214.      !begin_xlist [description environment:]
  2215.      !item [itemize environment:]
  2216.            for itemizations
  2217.      !item [enumerate environment:]
  2218.            for enumerations
  2219.      !item [description environment:]
  2220.            for descriptions
  2221.      !item [xlist environment:]
  2222.            for lists (discussed in this section)
  2223.      !end_xlist
  2224.  
  2225. ... will be displayed this way:
  2226.  
  2227. UDO offers you the following environments:
  2228.  
  2229.  itemize environment:     for itemizations
  2230.  
  2231.  enumerate environment:   for enumerations
  2232.  
  2233.  description environment: for descriptions
  2234.  
  2235.  xlist environment:       for lists (discussed in this section)
  2236.  
  2237.  
  2238. The command  !short can  also be used for xlist environments. To get a
  2239. compressed list just add !short at the end of the line  that  contains
  2240. !begin_xlist. Once more a short example:
  2241.  
  2242.      !begin_xlist [description:] !short
  2243.      !item [itemize:] Itemizations
  2244.      !item [enumerate:] Enumerations
  2245.      !item [description:] Descriptions
  2246.      !item [xlist:] Lists
  2247.      !end_xlist
  2248.  
  2249. ... will be displayed this way:
  2250.  
  2251.  itemize:     Itemizations
  2252.  enumerate:   Enumerations
  2253.  description: Descriptions
  2254.  xlist:       Lists
  2255.  
  2256.  
  2257. Since Release  6  UDO  offers  three  additional environments that are
  2258. familiar with the xlist environment. In contrast to the xlist environ-
  2259. ment the items will be displayed in bold, italic or typewritered text.
  2260.  
  2261.   1. When  using  the  blist environment (bold list) the items will be
  2262.      displayed in bold text. A blist environment will be started  with
  2263.      !begin_blist and finished with !end_blist.
  2264.  
  2265.   2. When  using the ilist environment (italic list) the items will be
  2266.      displayed in italic text. A blist  environment  will  be  started
  2267.      with !begin_ilist and finished with !end_ilist.
  2268.  
  2269.   3. When  using  the  tlist environment (typewritered list) the items
  2270.      will be displayed in typewritered text. A tlist environment  will
  2271.      be started with !begin_tlist and finished with !end_tlist.
  2272.  
  2273.  
  2274. The following example shall demonstrate the results:
  2275.  
  2276.      !begin_xlist [typewritered:]
  2277.      !item [normal:] !..
  2278.      !end_xlist
  2279.      
  2280.      !begin_blist [typewritered:]
  2281.      !item [bold:] !..
  2282.      !end_blist
  2283.      
  2284.      !begin_ilist [typewritered:]
  2285.      !item [italic:] !..
  2286.      !end_ilist
  2287.      
  2288.      !begin_tlist [typewritered:]
  2289.      !item [typewritered:] !..
  2290.      !end_tlist
  2291.  
  2292. ... will be displayed this way:
  2293.  
  2294.  normal:       ...
  2295.  
  2296.  bold:         ...
  2297.  
  2298.  italic:       ...
  2299.  
  2300.  typewritered: ...
  2301.  
  2302.  
  2303. You have to notice some aspects:
  2304.  
  2305.   1. If  the text inside the brackets contains a "]" you have to quote
  2306.      it with an exclamation mark so that UDO will recognize that  this
  2307.      "]" shall be part of the item and shall be displayed on the "left
  2308.      side".
  2309.  
  2310.   2. HTML, Linuxdoc-SGML and Texinfo don't support an environment like
  2311.      UDO's  xlist environment. In these formats the xlist environments
  2312.      are displayed like a description environment by default.  But  if
  2313.      you  use the switch !use_xlist inside the preamble UDO will print
  2314.      xlist environments like in ASCII, but with preformatted text.
  2315.  
  2316.   3. UDO doesn't know the character widths when converting the  source
  2317.      file to RTF and Windows Help. If the indents are too wide you can
  2318.      adjust  the  indent  by  using  the  commands  !rtf_charwidth and
  2319.      !win_charwidth.
  2320.  
  2321.   4. A  description  of  the  !short command  is  part  of the chapter
  2322.      "Itemizations".
  2323.  
  2324.  
  2325. 6.4.5  Centred text
  2326. -------------------
  2327.  
  2328. Lines that are part of a center environment will be displayed  centred
  2329. if the destination format centred text.
  2330.  
  2331. You can  use the center environment inside other environments. You can
  2332. also use it inside  another  center  environment,  even  this  may  be
  2333. senseless.
  2334.  
  2335. If you use other environments inside a center environment they will be
  2336. layouted like in all other cases. Only when the center environment  is
  2337. the active one text will be printed centred.
  2338.  
  2339. If the  following  example  isn't  centred  the  current documentation
  2340. format doesn't allow it to use centred text.
  2341.  
  2342.      !begin_center
  2343.      A centred line.
  2344.      
  2345.      A centred paragraph
  2346.      with two source lines.
  2347.      
  2348.      The Guide to (!nl)
  2349.      UDO
  2350.      !end_center
  2351.  
  2352. ... will be printed in this way:
  2353.  
  2354.                            A centred line.
  2355.  
  2356.               A centred paragraph with two source lines.
  2357.  
  2358.                              The Guide to
  2359.                                  UDO
  2360.  
  2361. You see that UDO layouts paragraphs of a center environment,  too.  To
  2362. insert a manual line break use the (!nl) command.
  2363.  
  2364.  
  2365. 6.4.6  Right justified text
  2366. ---------------------------
  2367.  
  2368. Lines that  are  part  of  a  flushright environment will be displayed
  2369. right justified if the destination  format  supports  right  justified
  2370. text.
  2371.  
  2372. You can  use the flushright environment inside other environments. You
  2373. can also use it inside another flushright environment, even  this  may
  2374. be senseless.
  2375.  
  2376. If you  use  other  environments  inside a flushright environment they
  2377. will be layouted like in all other cases. Only when the flushright en-
  2378. vironment is the active one text will be printed right justified.
  2379.  
  2380. If the  following  example  isn't  printed right justified the current
  2381. documentation format doesn't allow it to use right justified text.
  2382.  
  2383.      !begin_flushright
  2384.      A right justified line.
  2385.      
  2386.      A right justified paragraph
  2387.      with two source lines.
  2388.      
  2389.      The Guide to (!nl)
  2390.      UDO
  2391.      !end_flushright
  2392.  
  2393. ... will be printed in this way:
  2394.  
  2395.                                                A right justified line.
  2396.  
  2397.                     A right justified paragraph with two source lines.
  2398.  
  2399.                                                           The Guide to
  2400.                                                                    UDO
  2401.  
  2402. You see that UDO layouts paragraphs of a flushright environment,  too.
  2403. To insert a manual line break use the (!nl) command.
  2404.  
  2405.  
  2406. 6.4.7  Left justified text
  2407. --------------------------
  2408.  
  2409. Lines that  are part of a flushleft environment will be displayed left
  2410. justified without justification.
  2411.  
  2412. Er, do you understand that? No? OK, one  more  try.  If  you  use  the
  2413. switch  !use_justified UDO  adjusts  the  lines  by  inserting  spaces
  2414. between the words so that you have a  proper  right  margin.  But  UDO
  2415. won't insert spaces between words of a flushleft environment.
  2416.  
  2417. You can  use  the flushleft environment inside other environments. You
  2418. can also use it inside another flushleft environment, even this may be
  2419. senseless.
  2420.  
  2421. If you use other environments inside a flushleft environment they will
  2422. be layouted like in all other cases. Only when the flushleft  environ-
  2423. ment is the active one text will be printed without justification.
  2424.  
  2425. This short example...
  2426.  
  2427.      !begin_flushleft
  2428.      A left justified line.
  2429.      
  2430.      A left justified paragraph
  2431.      that will be printed
  2432.      without justification. This
  2433.      senseless sentence is added
  2434.      to demonstrate the missing
  2435.      justification.
  2436.      
  2437.      The Guide to (!nl)
  2438.      UDO
  2439.      !end_flushleft
  2440.  
  2441. ... will be printed in this way:
  2442.  
  2443. A left justified line.
  2444.  
  2445. A left justified paragraph that will be printed without justification.
  2446. This senseless sentence is added to demonstrate the missing
  2447. justification.
  2448.  
  2449. The Guide to
  2450. UDO
  2451.  
  2452. You see  that  UDO layouts paragraphs of a flushleft environment, too.
  2453. To insert a manual line break use the (!nl) command.
  2454.  
  2455.  
  2456. 6.4.8  Indented paragraphs
  2457. --------------------------
  2458.  
  2459. To display indented paragraphs you can use the quote environment which
  2460. is started with !begin_quote and finished with !end_quote. You can use
  2461. the quote environment inside another quote environment or inside other
  2462. environments.
  2463.  
  2464. This environment  is useful to emphasize passages. This effect is used
  2465. in the following example:
  2466.  
  2467.      !begin_quote
  2468.      This paragraph is used inside a
  2469.      quote environment and will be
  2470.      displayed indented.
  2471.      !end_quote
  2472.  
  2473. ... becomes to:
  2474.  
  2475.      This paragraph is used inside a quote environment  and  will
  2476.      be displayed indented.
  2477.  
  2478. Please note: When  converting  to  HTML  the tag <BLOCKQUOTE> is used.
  2479. Netscape and CAB display paragraphs indented but Mosaic displays  them
  2480. just with another font.
  2481.  
  2482.  
  2483. 6.4.9  Preformatted text
  2484. ------------------------
  2485.  
  2486. UDO layouts  the text of the source file on its own. But sometimes you
  2487. don't want that because you want to display preformatted  things  like
  2488. parts of a source code or something else.
  2489.  
  2490. To display preformatted text you can use the verbatim environment that
  2491. is started with !begin_verbatim and finished  with  !end_verbatim.  No
  2492. UDO commands (except !end_verbatim) or placeholders will be converted.
  2493. Text inside this environment will be indented like normal text.
  2494.  
  2495. When converting into LaTeX the commands of UDO will be  just  replaced
  2496. by   the  LaTeX  commands  \begin{verbatim} and  \end{verbatim}.  When
  2497. converting to another format UDO adjusts special  chars  and  displays
  2498. the text with a non-proportional font.
  2499.  
  2500. If the  lines  of  the verbatim environment contain tabs (ASCII 9) UDO
  2501. will replace them by spaces according to the !tabwidth setting.
  2502.  
  2503.  
  2504. Because no commands inside a  verbatim  environment  are  noticed  you
  2505. cannot use the !include command inside this environment.
  2506.  
  2507. To enable  you  to include an external file and display it as it would
  2508. be inside a verbatim environment UDO offers you the command !vinclude.
  2509. This   command   is   a   mixture   of  !begin_verbatim,  !include and
  2510. !end_verbatim.
  2511.  
  2512. To write special commands for the destination format  you  cannot  use
  2513. this environment. You have to use the raw environment instead.
  2514.  
  2515.  
  2516. Please note:
  2517.  
  2518.   1. Because  the  text  of  a  verbatim  environment is indented like
  2519.      normal text you shouldn't use extra spaces at  the  beginning  of
  2520.      each line.
  2521.  
  2522.   2. The difference between the raw environment and the verbatim envi-
  2523.      ronment is that text of a verbatim environment will be  displayed
  2524.      an  you  entered  it, but text of a raw environment will be saved
  2525.      into the destination file as you entered it.
  2526.  
  2527.  
  2528. 6.4.10  Footnotes
  2529. -----------------
  2530.  
  2531. Text that is used between (!N) and (!n) will be shown  as  a  footnote
  2532. when  converting  to  a format that supports footnotes. Otherwise (!N)
  2533. will be replaced by ` (', (!n) will be replaced by `)'.
  2534.  
  2535. Important hint: Before (!N) you shouldn't use a blank. If  you  do  so
  2536. the  footnote  mark  would "fly" without context or before the `(' you
  2537. could read two blanks.
  2538.  
  2539. This example...
  2540.  
  2541.      UDO(!N)Universal Document(!n)
  2542.  
  2543. ... becomes to:
  2544.  
  2545.      UDO (Universal Document)
  2546.  
  2547. Footnotes are supported by these formats:
  2548.  
  2549.    ⁿ LaTeX
  2550.    ⁿ Linuxdoc-SGML
  2551.    ⁿ LyX
  2552.    ⁿ Texinfo
  2553.    ⁿ RTF
  2554.  
  2555. Please note:
  2556.  
  2557.   1. I'm a bit unlucky that UDO just prints brackets if  the  destina-
  2558.      tion  format  doesn't support footnotes. It will be better if UDO
  2559.      saves the footnote text and prints it at the end of a chapter  or
  2560.      page.  Unfortunately this is a very tricky problem that cannot be
  2561.      solved in some days.
  2562.  
  2563.   2. Don't forget not to use a space or tab before (!N).
  2564.  
  2565.  
  2566. 6.4.11  Text styles
  2567. -------------------
  2568.  
  2569. UDO enables you to set text styles right inside the source file.
  2570.  
  2571. At the moment UDO supports bold, italic, underlined,  preformatted and
  2572. non-proportional text.
  2573.  
  2574. If you  want  to display a single word or some words in a certain text
  2575. style you have to use them between the according  placeholders.  Look,
  2576. how the upper paragraph was made:
  2577.  
  2578. At the moment UDO supports
  2579. (!B)bold(!b),
  2580. (!I)italic(!i),
  2581. (!U)underlined(!u),
  2582. (!V)preformatted(!v) and
  2583. (!T)non-proportional text(!t).
  2584.  
  2585. In this  table  you  will  see  in  which way the placeholders will be
  2586. replaced:
  2587.  
  2588.  
  2589.  +------+-------+----------+-------------+------+---------+--------+
  2590.  | UDO  | ASCII | ST-Guide | LaTeX       | RTF  | WinHelp | HTML   |
  2591.  +------+-------+----------+-------------+------+---------+--------+
  2592.  | (!B) | *     | @{B}     | {\bf        | {\b  | {\b     | <B>    |
  2593.  | (!b) | *     | @{b}     | }           | }    | }       | </B>   |
  2594.  +------+-------+----------+-------------+------+---------+--------+
  2595.  | (!I) | /     | @{I}     | {\it        | {\i  | {\i     | <I>    |
  2596.  | (!i) | /     | @{i}     | }           | }    | }       | </I>   |
  2597.  +------+-------+----------+-------------+------+---------+--------+
  2598.  | (!U) | _     | @{U}     | {\underline | {\ul | {\ul    | <U>    |
  2599.  | (!u) | _     | @{u}     | }           | }    | }       | </U>   |
  2600.  +------+-------+----------+-------------+------+---------+--------+
  2601.  | (!V) |       |          | \verb+      | {\f1 | {\f1    | <PRE>  |
  2602.  | (!v) |       |          | +           | }    | }       | </PRE> |
  2603.  +------+-------+----------+-------------+------+---------+--------+
  2604.  | (!T) |       |          | {\tt        | {\f1 | {\f1    | <TT>   |
  2605.  | (!t) |       |          | }           | }    | }       | </TT>  |
  2606.  +------+-------+----------+-------------+------+---------+--------+
  2607.  
  2608. As you see here for the ASCII format there will be used the text style
  2609. commands  as  they  are used in Usenet. If you don't like them you can
  2610. use   the   switch   called   !no_effects to   suppress   them.    Use
  2611. !no_effects [asc] to  suppress the text style commands when converting
  2612. to ASCII.
  2613.  
  2614. Please note: Definitions are great for programming  user-defined  text
  2615. styles.  It's for sure that you need some knowledge about the destina-
  2616. tion forma to do this. The following example show how to  use  ghosted
  2617. text which is available for the ST-Guide:
  2618.  
  2619.      !ifdest [stg]
  2620.          !define G @{G}
  2621.          !define g @{g}
  2622.      !else
  2623.          !define G
  2624.          !define g
  2625.      !endif
  2626.      
  2627.      Normal and (!G)ghosted(!g).
  2628.  
  2629.  
  2630. 6.4.12  Tables
  2631. --------------
  2632.  
  2633. Since Release  5 you are able to print simple tables with UDO. You can
  2634. define the justification of the columns  and  where  UDO  shall  print
  2635. vertical and/or horizontal lines.
  2636.  
  2637. To print tables with UDO you need the following commands:
  2638.  
  2639.   1. !table_caption <text>
  2640.   2. !begin_table [...] {!hline}
  2641.   3. !end_table
  2642.   4. !hline
  2643.   5. !!
  2644.  
  2645. The command !table_caption defines the title of the next table. It has
  2646. to be used before the table environment, not inside this environment!
  2647.  
  2648. The command  !begin_table starts  a  table,  !end_table finishes   and
  2649. prints  the table. After !begin_table you can define the justification
  2650. of the table columns and the usage of vertical lines. Use  `c'  for  a
  2651. centred  row,  `l' for a left justified row, `r' for a right justified
  2652. row and `|' for vertical lines inside brackets. If you  add  a  !hline
  2653. command to this line the table starts with a horizontal line.
  2654.  
  2655. After having described the layout of the table with the upper line you
  2656. can insert the cells of the table. You have to insert a column in  one
  2657. source line and you have to divide the cells by using `!!'.
  2658.  
  2659. If you  want  to  insert  a  horizontal  line  you  can use the !hline
  2660. command. !hline has to be at the beginning of the line and it  has  to
  2661. be the only command of this line.
  2662.  
  2663. Here you  will  see a short example that demonstrates the usage of the
  2664. upper described commands:
  2665.  
  2666.      !table_caption Tables with UDO
  2667.      !begin_table [|l|c|r|] !hline
  2668.      upper left !! up !! upper right
  2669.      lower left cell !! lower cell !! lower right cell
  2670.      !hline
  2671.      !end_table
  2672.  
  2673. This example prints a table with two rows and three columns. The first
  2674. column  is left justified, the second columns is centred and the third
  2675. columns is printed right justified:
  2676.  
  2677.  
  2678.          +-----------------+------------+------------------+
  2679.          | upper left      |     up     |      upper right |
  2680.          | lower left cell | lower cell | lower right cell |
  2681.          +-----------------+------------+------------------+
  2682.  
  2683.                        Table 4: Tables with UDO
  2684.  
  2685.  
  2686. Because I used a `|' before and after every column they are divided by
  2687. vertical  lines.  The  table starts with a horizontal line because the
  2688. !hline command was added at the end of !begin_table. Finally the table
  2689. ends  with  a horizontal line because the !hline command is used right
  2690. before !end_table.
  2691.  
  2692.  
  2693. The following example shows the upper table without any lines:
  2694.  
  2695.  
  2696.             upper left           up           upper right 
  2697.             lower left cell  lower cell  lower right cell 
  2698.  
  2699.                        Table 5: Another example
  2700.  
  2701.  
  2702.  
  2703. UDO offers you a switch  called  !use_ansi_tables.  If  you  use  this
  2704. switch inside the preamble the lines of the table are printed by using
  2705. some characters of the IBM PC graphic character set instead  of  +,  -
  2706. and  | when  converting  into  an  ASCII like format like ASCII or ST-
  2707. Guide. This switch has no effect if you convert to Windows Help,  RTF,
  2708. HTML or LaTeX.
  2709.  
  2710.  
  2711. Please note:
  2712.  
  2713.    ⁿ Tables are always printed centred.
  2714.  
  2715.    ⁿ HTML  doesn't  allow to define where to use lines. If you use the
  2716.      !hline command at the end of !begin_table the  table  is  printed
  2717.      via  frame=box. If you don't use !hline it is printed without any
  2718.      lines.
  2719.  
  2720.    ⁿ Windows Help doesn't allow it to print centred tables or to print
  2721.      lines  where  you  want to. If you use !hline in the !begin_table
  2722.      line all cells will be printed with  a  box.  If  you  don't  use
  2723.      !hline there will be no line at all in this table.
  2724.  
  2725.    ⁿ Converting  to  ST-Guide  the lines of a table are generated with
  2726.      @line. It's not possible to  use  more  than  one  vertical  line
  2727.      between columns or more than one horizontal line.
  2728.  
  2729.    ⁿ Inside  the  cells  you  can use all other UDO commands like text
  2730.      styles, links or indices.
  2731.  
  2732.  
  2733. 6.5  Special characters
  2734. =======================
  2735.  
  2736.  
  2737. 6.5.1  Double quotes
  2738. --------------------
  2739.  
  2740. Double quotes of the source file will be  converted  to  typographical
  2741. quotes  if they are supported by the destination format. The following
  2742. ASCII simulation demonstrates how it works:
  2743.  
  2744.      Double ""quotes""
  2745.      
  2746.             66       99
  2747.      Double    quotes
  2748.  
  2749. If you want to  display  two  quotes  you  have  to  use  ("")text("")
  2750. instead.
  2751.  
  2752. Please note:
  2753.  
  2754.   1. The conversion of these double quotes can be suppressed using the
  2755.      switch called !no_quotes [ ].
  2756.  
  2757.   2. When converting to RTF special RTF commands will be used.
  2758.  
  2759.  
  2760. 6.5.2  Double apostrophes
  2761. -------------------------
  2762.  
  2763. Like double quotes UDO can convert double apostrophes into typographi-
  2764. cal apostrophes:
  2765.  
  2766.      double ''apostrophes''
  2767.  
  2768. will become
  2769.  
  2770.      double `apostrophes'
  2771.  
  2772. If you  want  to  display two apostrophes you have to use ('')text('')
  2773. instead.
  2774.  
  2775. Please note: The switch !no_quotes [ ] switches off the conversion  of
  2776. these double apostrophes, too.
  2777.  
  2778.  
  2779. 6.5.3  Non breaking spaces
  2780. --------------------------
  2781.  
  2782. If you  want  to insert non-breaking spaces between two words you have
  2783. to use the tilde (~). Non-breaking spaces are also useful to stop  UDO
  2784. and the other formats from breaking lines between two words.
  2785.  
  2786. Converting to  an  ASCII  format  UDO  replaces this tildes by blanks.
  2787. Converting to other formats UDO replaces this tildes by commands  that
  2788. have the same effect.
  2789.  
  2790.  LaTeX:   ~
  2791.  HTML:     
  2792.  RTF:     \~
  2793.  WinHelp: \~
  2794.  
  2795. If you want to display a tilde you have to use !~ instead.
  2796.  
  2797. Please note: If  you  use  a  tilde  inside an external link UDO won't
  2798. convert it.
  2799.  
  2800.  
  2801. 6.5.4  Dashs
  2802. ------------
  2803.  
  2804. UDO supports - did you think  anything  else  -  dashs  like  in  this
  2805. sentence.
  2806.  
  2807. Dashs are  supported  by  LaTeX,  Windows  Help and RTF. Converting to
  2808. other formats UDO will replace `---' and `--' by a single `-'.
  2809.  
  2810. If you want to display three or two `-' you have to use (---) or (--).
  2811.  
  2812.  
  2813. 6.5.5  Converting 8 bit chars
  2814. -----------------------------
  2815.  
  2816. In an UDO source file you can use "higher" characters  without  having
  2817. to  know how a character has to look like in a destination format like
  2818. LaTeX or Windows Help. So you can enter a German `∧' without any fear,
  2819. UDO  converts  it for you and it knows that this has to be ß for
  2820. HTML or {\ss} for LaTeX.
  2821.  
  2822. UDO expects files containing chars  of  the  system  charset  of  your
  2823. operating system. If you run UDO on a MS-DOS computer UDO expects text
  2824. files that are written with the IBM PC character set  by  default.  If
  2825. UDO runs on an Atari computer UDO will expect the TOS character set by
  2826. default.
  2827.  
  2828. But UDO can manage file that are written with another  character  set,
  2829. too.  You have simply to tell UDO which character set your source file
  2830. uses with the following commands:
  2831.  
  2832.  !code_dos: IBM-PC, MS-DOS
  2833.  !code_hp8: HP Roman 8
  2834.  !code_iso: ISO Latin 1, Windows ANSI
  2835.  !code_mac: Apple Macintosh
  2836.  !code_tos: Atari ST
  2837.  
  2838.  
  2839. There are some things  you  have  to  remember.  Some  character  sets
  2840. contain  characters  that  aren't  available  in  another  one. So you
  2841. shouldn't use characters from the PC  graphic  character  set  or  the
  2842. Hebraic  characters  of  the Atari character set because they can't be
  2843. printed in formats like LaTeX, Windows Help, RTF or HTML. In this case
  2844. UDO  prints  an error message. You should remove these characters from
  2845. your source file and find another solution.
  2846.  
  2847. If source files are converted that don't use the character set of  the
  2848. operating system UDO is running on the limitations are even higher. In
  2849. the first step UDO will convert the characters into ISO  Latin  1.  In
  2850. the  second  step UDO will convert the ISO Latin 1 characters into the
  2851. character set of the current operating system. In some  cases  there's
  2852. is  no possibility to convert the characters without any loss. In such
  2853. a case UDO will print an error message.
  2854.  
  2855. Please note: If  I've  forgotten  any  character  or  a  character  is
  2856. converted in a wrong way please send a bug report!
  2857.  
  2858.  
  2859. 6.6  Syllabification
  2860. ====================
  2861.  
  2862. UDO supports  a  semi-automatic  syllabification  for ASCII, ST-Guide,
  2863. Pure C Help and Manualpage. "Semi-automatic" means that  you  have  to
  2864. tell UDO at which position a word can be divided into two pieces.
  2865.  
  2866. You have two possibilities to set the syllabification patterns:
  2867.  
  2868.   1. Local definition ("!-")
  2869.   2. Global definition using the !hyphen command
  2870.  
  2871. When converting  to  LaTeX  the  marks  will be replaced by "\-". Then
  2872. LaTeX knows that a word can be split at these positions.
  2873.  
  2874. When converting to RTF, Windows Help and HTML the marks are deleted.
  2875.  
  2876. If you want to display !- you have to use !/-.
  2877.  
  2878.  
  2879. 6.6.1  Local definition of syllabification patterns
  2880. ---------------------------------------------------
  2881.  
  2882. You can set the syllabification marks in the source file using "!-".  At
  2883. these marks UDO is allowed to split up a word. A short example:
  2884.  
  2885.      semi-automatic syl!-labi!-fi!-cation
  2886.  
  2887. When converting to LaTeX UDO replaces all "!-" by "\-". So it would look
  2888. like "syl\-labi\-fi\-cation".
  2889.  
  2890. Converting to ASCII, ST-Guide, Pure C Help and Manualpage the word  is
  2891. split  up  into different parts if it doesn't have enough place at the
  2892. end of a line. So it can  look  like  "syl-  labification",  "syllabi-
  2893. fication" or "syllabifi- cation"
  2894.  
  2895. When converting to other formats the marks are simply deleted.
  2896.  
  2897.  
  2898. 6.6.2  Global definition of syllabification patterns
  2899. ----------------------------------------------------
  2900.  
  2901. You can  set  these  marks  at the beginning of a source file with the
  2902. !hyphen command for often used words. "Global"  means  that  you  only
  2903. have to define the marks once.
  2904.  
  2905. If a  word hasn't enough place at the end of a line when converting to
  2906. ASCII, ST-Guide, Pure C Help or Manualpage  UDO  looks  for  a  global
  2907. definition in its internal list.
  2908.  
  2909. In the  following  example  I  expect that the word "documentation" is
  2910. used many times in your source file:
  2911.  
  2912.      !hyphen docu!-men!-ta!-tion
  2913.  
  2914.  
  2915. 6.6.3  Short lines
  2916. ------------------
  2917.  
  2918. When converting to ASCII, Pure C Help, ST-Guide or Manualpage UDO  can
  2919. generate  a  relative  regular  right margin due to its semi-automatic
  2920. syllabification.
  2921.  
  2922. The right margin becomes irregular  when  long  words  haven't  enough
  2923. place  at  the  end of a line. UDO will print a warning containing the
  2924. specific word and you should try to insert some syllabification marks.
  2925.  
  2926. Please note:
  2927.  
  2928. The command !sloppy switches of these warnings,  !fussy switches  them
  2929. back  on.  While developing a documentation you should use !sloppy. At
  2930. the end of developing a text you should comment this  switch  and  you
  2931. should look after warnings according short lines.
  2932.  
  2933.  
  2934. 6.7  Images
  2935. ===========
  2936.  
  2937. UDO enables  you  to include images into your destination format if it
  2938. supports images like ST-Guide, LaTeX,  HTML  and  Windows  Help.  This
  2939. chapter  explains  how  to  include images into a destination file and
  2940. what destination commands UDO generates.
  2941.  
  2942. To display an image you can use the !image command. You  have  to  add
  2943. the name of the image without suffix and an optional image title.
  2944.  
  2945. To display  images  right  inside the text you can use the placeholder
  2946. (!img ..) when converting into Windows Help or HTML. The other formats
  2947. don't  allow  to use images inside the text or it is so difficult that
  2948. UDO can't automatize it.
  2949.  
  2950. Since Release 6 images will not be centred in all cases. To display  a
  2951. centred  image you have to insert the !image command into a center en-
  2952. vironment. To display a right justified image you have to  insert  the
  2953. !image command  inside  a  flushright  environment. In all other cases
  2954. images will be displayed left justified.
  2955.  
  2956.  
  2957. 6.7.1  *.img & ST-Guide
  2958. -----------------------
  2959.  
  2960. Example: !image tiger A tiger
  2961.  
  2962. UDO opens the file tiger.img and reads  the  size  of  this  image.  A
  2963. special  ST-Guide  command  called @limage is generated and the needed
  2964. parameters are calculated due to the  information  of  the  GEM  image
  2965. header.
  2966.  
  2967. If you  want  to display a subtitle add it right after the name of the
  2968. image file. This subtitle will look like "(Figure x: A tiger)".
  2969.  
  2970.  
  2971. 6.7.2  *.img & Lindner-TeX
  2972. --------------------------
  2973.  
  2974. If you are using Lindner-TeX and you want to include a GEM image  into
  2975. your DVI file you have to add !tex_lindner to your preamble.
  2976.  
  2977. UDO replaces the tool called IMGTOTEX that is part of Lindner-TeX. UDO
  2978. has all functions of this tool built in.
  2979.  
  2980. To set the size of an image you have to use the  !tex_dpi command.  An
  2981. example:
  2982.  
  2983.      !tex_dpi 100
  2984.      !image tiger A GEM image
  2985.  
  2986. UDO reads  in the header of tiger.img, calculates its size and adjusts
  2987. the header to 100 dpi. In the destination file a  TeX  macro  will  be
  2988. generated that includes this image and displays it with 100 dpi.
  2989.  
  2990.  
  2991. Please note: Using  100  dpi screenshots are displayed in the original
  2992. screen size on my HP DeskJet 510.  !tex_dpi can  be  used  before  any
  2993. image.  If  you are using an image more than once you shouldn't try to
  2994. display it in different resolutions. Use a copy of your image  instead
  2995. and  display  the  original  one  with the first and the copy with the
  2996. second resolution.
  2997.  
  2998.  
  2999. 6.7.3  *.img & CS-TeX/MultiTeX
  3000. ------------------------------
  3001.  
  3002. If you are using CS-TeX or MultiTeX and you  want  to  include  a  GEM
  3003. image into your DVI file you have to add !tex_strunk to your preamble.
  3004.  
  3005. Because the  drivers  of  CS-TeX support the macros of Lindner-TeX the
  3006. same is done here as in the upper section.
  3007.  
  3008.  
  3009. 6.7.4  *.msp & emTeX
  3010. --------------------
  3011.  
  3012. If you are using emTeX and you want to include an MSP  image  to  your
  3013. DVI  file you have to add !tex_emtex to your preamble. Furthermore you
  3014. have to set the resolution of an image via !tex_dpi.
  3015.  
  3016. The macros for emTeX are generated according  to  the  information  of
  3017. dvidrv.doc of emTeX.
  3018.  
  3019. In first  place  UDO  tries  to  read  in the header of tiger.msp when
  3020. reading the  command  !image  tiger  A  tiger.  If  UDO  doesn't  find
  3021. tiger.msp it will try to find tiger.pcx.
  3022.  
  3023. An example  shows  what kind of macro UDO generates for emTeX. `w' and
  3024. `h' represent the width and height of the image:
  3025.  
  3026.      \begin{figure}[htb]
  3027.      \begin{...}
  3028.      \begin{picture}(<w>,<h>)
  3029.          \put(0,<h>){\special{em:graph tiger.msp}}
  3030.      \end{picture}
  3031.      \end{...}
  3032.      \caption{A tiger}
  3033.      \end{figure}
  3034.  
  3035. Please note: I use !tex_dpi  300 on  my  HP  DeskJet  510  to  display
  3036. screenshots.
  3037.  
  3038.  
  3039. 6.7.5  *.pcx & emTeX
  3040. --------------------
  3041.  
  3042. If you  are  using  emTeX  and you want to include a Paintbrush PCX to
  3043. your DVI file you have to add !tex_emtex to your preamble. Furthermore
  3044. you have to set the resolution of an image via !tex_dpi.
  3045.  
  3046. The macros  for  emTeX  are  generated according to the information of
  3047. dvidrv.doc of emTeX.
  3048.  
  3049. In first place UDO tries to  read  in  the  header  of  tiger.msp when
  3050. reading  the  command  !image  tiger  A  tiger.  If  UDO  doesn't find
  3051. tiger.msp it will try to find tiger.pcx.
  3052.  
  3053. An example shows what kind of macro UDO generates for emTeX.  `w'  and
  3054. `h' represent the width and height of the image:
  3055.  
  3056.      \begin{figure}[htb]
  3057.      \begin{...}
  3058.      \begin{picture}(<w>,<h>)
  3059.          \put(0,<h>){\special{em:graph tiger.pcx}}
  3060.      \end{picture}
  3061.      \end{...}
  3062.      \caption{A tiger}
  3063.      \end{figure}
  3064.  
  3065.  
  3066. Note: In  first place UDO tries to find an MSP image. If you are using
  3067. images from Paintbrush PCX you can ignore the warning printed by UDO.
  3068.  
  3069.  
  3070. 6.7.6  *.gif & HTML
  3071. -------------------
  3072.  
  3073. UDO can generate HTML commands to include a GIF. UDO doesn't check  if
  3074. the GIF is existing!
  3075.  
  3076. For HTML  the  second  parameter of the !image command will be used as
  3077. the alternative  text.  The  command  !image  tiger  A  tiger will  be
  3078. converted into the following HTML commands:
  3079.  
  3080.      <p align=...>
  3081.      <img src="tiger.gif" alt="(Figure 1: A tiger)">
  3082.      </p><br>
  3083.  
  3084. If you  don't  set  the  title  of  this  image  UDO doesn't output an
  3085. alternative text. The command  !image  tiger will  be  converted  into
  3086. this:
  3087.  
  3088.      <p align=...>
  3089.      <img src="../gif/tiger.gif" alt="">
  3090.      </p><br>
  3091.  
  3092.  
  3093. 6.7.7  *.jpg & HTML
  3094. -------------------
  3095.  
  3096. By default UDO expects that you want to display GIF's (see above). But
  3097. it's possible to display any other kind of image format, too.
  3098.  
  3099. To tell UDO which suffix you want to use the next  time  you  use  the
  3100. !image command you can use the command !html_img_suffix.
  3101.  
  3102. If the  upper tiger isn't inside a GIF but inside a JPEG image you can
  3103. insert the following command right before the !image command:
  3104.  
  3105.      !html_img_suffix jpg
  3106.  
  3107. If the file is named tiger.jpeg instead of tiger.jpg use the following
  3108. line:
  3109.  
  3110.      !html_img_suffix jpeg
  3111.  
  3112. The setting is used for all following images. If you want to display a
  3113. GIF next time you have to  use  !html_img_suffix gif before  the  next
  3114. !image command is used.
  3115.  
  3116.  
  3117. 6.7.8  *.bmp & WinHelp
  3118. ----------------------
  3119.  
  3120. UDO can  generate commands for Windows Help to display Windows bitmaps
  3121. (BMP). UDO doesn't check if a BMP is existing!
  3122.  
  3123. An image can be displayed with or without  a  subtitle.  Windows  Help
  3124. centers the image in the help file.
  3125.  
  3126.   1. without subtitle: !image tiger
  3127.  
  3128.   2. with subtitle: !image tiger A tiger
  3129.  
  3130. UDO will then generate these commands:
  3131.  
  3132.      {\qc \{bmc tiger.bmp\}}\par\pard
  3133.      \par
  3134.      {\qc (Figure 1: A tiger)}\par\pard
  3135.  
  3136. Please note:
  3137.  
  3138.   1. UDO  won't  check  if  the  image file is existing. If it doesn't
  3139.      exists or the filename is wrong the Microsoft  Helpcompiler  will
  3140.      print an error message.
  3141.  
  3142.   2. With  the  switch  !win_inline_bitmaps you  can  tell  UDO to use
  3143.      special Windows Help commands to use "hard-coded" images.
  3144.  
  3145.  
  3146. 6.8  Hypertext commands
  3147. =======================
  3148.  
  3149.  
  3150. 6.8.1  Labels
  3151. -------------
  3152.  
  3153. Using the command !label you can set labels inside the source file. An
  3154. example:
  3155.  
  3156.      !label example
  3157.  
  3158. When converting  to the hypertext formats Windows Help, HTML, ST-Guide
  3159. and Pure C Help UDO inserts references inside the text to  this  label
  3160. automatically.  You  can  search  for  these  labels inside the search
  3161. dialog of Windows Help.
  3162.  
  3163. When you set the upper label you can jump from  every  position  where
  3164. the word "example" is used to the position where you used the label.
  3165.  
  3166. Here a list how UDO converts a label for the hypertext formats:
  3167.  
  3168.  HTML:          <a name="example"</a>
  3169.  LaTeX:         \label{example}
  3170.  Linuxdoc-SGML: <label id="example">
  3171.  Pure-C-Help:   sensitive("example") inside the header
  3172.  ST-Guide:      @symbol ar example
  3173.  Turbo-Vision:  .topic example inside the header
  3174.  WinHelp:       #{\footnote # example}
  3175.  
  3176.  
  3177. Please note: You  shouldn't use special chars like commas, semicolons,
  3178. quotes or apostrophes inside the label text because some formats  have
  3179. problems  with  these special characters. Please try to avoid them. In
  3180. most cases you can avoid them if you really want.
  3181.  
  3182.  
  3183. 6.8.2  Links
  3184. ------------
  3185.  
  3186. Sometimes you maybe want to set a link to other parts of  the  current
  3187. document  or to other documents. To make it possible for you to insert
  3188. links UDO offers you the placeholders called  (!link...),  (!xlink...)
  3189. and (!plink...).
  3190.  
  3191. Please note: If  you want to use a "(" or a "]" inside a link you have
  3192. to quote it with an exclamation mark:
  3193.  
  3194.      Wrong: (!link [Brackets])] [Link])
  3195.      Right: (!link [Brackets!]!)] [Link])
  3196.                             ----
  3197.  
  3198.  
  3199. 6.8.2.1  Internal links
  3200.  
  3201. Using the (!link...) command you can insert  links  to  parts  of  the
  3202. current  document.  You  can  link to chapters, sections, subsections,
  3203. labels and aliases. The following list shows you how to use  the  link
  3204. command and how UDO converts it:
  3205.  
  3206.      UDO:       (!link [a word] [the link])
  3207.      HTML:      <a href="file.htm#the link">a word</a>
  3208.      LaTeX:     a word (see \ref{the link})
  3209.      ST-Guide:  @{"a word" link "the link"}
  3210.      WinHelp:   {\uldb a word}{\v the_link}
  3211.      Turbo:     {a word:the_link}
  3212.      else:      a word (see "the link")
  3213.  
  3214. The following  example  shows  how  to  insert  a  link  to my contact
  3215. addresses:
  3216.  
  3217.      If you want to register UDO,
  3218.      please send (!link [me] [Contact addresses])
  3219.      an email.
  3220.  
  3221. ... will be displayed this way:
  3222.  
  3223. If you want to register UDO, please send me (see "Contact  addresses")
  3224. an email.
  3225.  
  3226. Please note:
  3227.  
  3228.   1. You may use up to (!MAXLINKS) inside a paragraph. If you will use
  3229.      more links UDO will print an error message.
  3230.  
  3231.   2. When converting to hypertext formats UDO checks if the link  des-
  3232.      tination exists. If it doesn't exits UDO prints an error message.
  3233.      When converting to the other formats UDO  doesn't  check  if  the
  3234.      link destination exists!
  3235.  
  3236.   3. LaTeX only allows it to link to aliases and labels.
  3237.  
  3238.  
  3239. 6.8.2.2  Internal links with images
  3240.  
  3241. Especially for  Windows Help and HTML there's existing the (!ilink...)
  3242. ("image  link")  commands.  It  is  a  mixture  of  the  (!img...) and
  3243. (!link...) command  that allows to display "hyperimages". If you click
  3244. an image you will jump to another part of the current document.
  3245.  
  3246.      UDO:      (!ilink [img] [text] [link])
  3247.      WinHelp:  {\uldb \{bmc img.bmp\}}{\v link}
  3248.      HTML:     <a href="link"><img src="img.gif" alt="text"></a>
  3249.      else:     like (!link [text] [link])
  3250.  
  3251. Please note:
  3252.  
  3253.   1. UDO won't check if the images exist.
  3254.  
  3255.   2. By default  UDO  uses  `.gif'  as  the  suffix  for  images  when
  3256.      converting  to  HTML. You can use the command !html_img_suffix to
  3257.      change the suffix.
  3258.  
  3259.   3. You may use up to (!MAXLINKS) inside a paragraph. If you will use
  3260.      more links UDO will print an error message.
  3261.  
  3262.  
  3263. 6.8.2.3  Internal links to pages
  3264.  
  3265. Especially for  LaTeX  there's  existing the (!plink...) ("page link")
  3266. command:
  3267.  
  3268.      UDO:    (!plink [link commands] [Links])
  3269.      LaTeX:  link commands (see page \pageref{Links})
  3270.      else:   link commands
  3271.  
  3272. The following example shows how to insert a page like to the page that
  3273. contains my contact addresses:
  3274.  
  3275.      If you want to register UDO,
  3276.      please send (!plink [me] [Contact addresses])
  3277.      an email.
  3278.  
  3279. ... will be displayed this way:
  3280.  
  3281. If you want to register UDO, please send me an email.
  3282.  
  3283. Please note:
  3284.  
  3285.   1. You  can  only  insert  page  links to labels and aliases, not to
  3286.      chapters when converting to LaTeX.
  3287.  
  3288.   2. You may use up to (!MAXLINKS) inside a paragraph. If you will use
  3289.      more links UDO will print an error message.
  3290.  
  3291.  
  3292. 6.8.2.4  External links
  3293.  
  3294. With the (!xlink...) ("external link") command you can insert links to
  3295. (parts of) other documents, net sites or hypertexts. The difference to
  3296. the upper command: UDO doesn't adjust special chars of the link desti-
  3297. nation. The tilde isn't a non-breaking space in the link  destination,
  3298. too.
  3299.  
  3300.      UDO:       (!xlink [UDO] [*:\udo.hyp])
  3301.      ST-Guide:  @{"UDO" link "*:\udo.hyp"}
  3302.      
  3303.      UDO:       (!xlink [Atari] [http://www.atari.com])
  3304.      HTML:      <A HREF="http://www.atari.com">Atari</A>
  3305.      
  3306.      UDO:       (!xlink [UDO] [Titel@d:/winhelp/udo.hlp])
  3307.      WinHelp:   {\uldb UDO}{\v Titel@d:/winhelp/udo.hlp}
  3308.      
  3309.      else:     UDO (or Atari)
  3310.  
  3311. Please note:
  3312.  
  3313.   1. You  have  to  use existing topic names for Windows Help. A topic
  3314.      name must contain only numbers and characters form the  alphabet.
  3315.      All other characters will be converted by UDO.
  3316.  
  3317.   2. You should use `*:\' at the beginning of an external link for the
  3318.      ST-Guide to tell it to look for the hypertext in all  directories
  3319.      you defined with PATHS in your ST-GUIDE.INF.
  3320.  
  3321.   3. Using  the  switch  called  !no_xlinks [...] you can suppress the
  3322.      conversion of external links. This  is  useful  if  you  wrote  a
  3323.      source  file  especially  for HTML and you want to make a version
  3324.      for Windows Help or ST-Guide, where the  external  file  wouldn't
  3325.      make no sense.
  3326.  
  3327.  
  3328. 6.9  Miscellaneous
  3329. ==================
  3330.  
  3331.  
  3332. 6.9.1  Macros
  3333. -------------
  3334.  
  3335. Macros are  userdefined  placeholders  that  you can use for different
  3336. purposes.
  3337.  
  3338. When using the !macro command you tell UDO the name of  the  macro  in
  3339. first  place.  The name of the macro is followed by its contents which
  3340. may be empty, too.
  3341.  
  3342. Let me show you some examples:
  3343.  
  3344.      !macro HTML Hypertext Markup Language
  3345.      !macro UDO  (!B)U(!b)niversal (!B)Do(!b)cument
  3346.      !macro DOSG (!T)UDO6GDOS.ZIP(!t)
  3347.      !ifdest [html]
  3348.        !macro PICPATH gif/
  3349.      !else
  3350.        !macro PICPATH img/
  3351.      !endif
  3352.      [...]
  3353.      The (!HTML) ...
  3354.      The (!UDO) Format ...
  3355.      The archive named (!DOSG) ...
  3356.      !image (!PICPATH)/tiger
  3357.  
  3358. Macros can help you to save time when typing often  used  long  words.
  3359. Furthermore macros can help you to change the contents of your file by
  3360. simply changing the contents for macros (e.g.  if  your  program  name
  3361. changed  and  you  use  a macro for the name of your program). Another
  3362. example is the usage of standardized text (e.g. a standard disclaimer)
  3363. where  you  use  macros  instead of the name of the program etc. These
  3364. standardized texts can be included with  !include.  In  the  following
  3365. example  a  disclaimer  is  included  and  the  name of the program is
  3366. defined by a macro:
  3367.  
  3368.      [doku.u]
  3369.      !macro PRG Windows95
  3370.      [disclaim.u]
  3371.      (!PRG) is provided ""as is"" without a
  3372.      warranty of any kind.
  3373.      Use it on your own risk.
  3374.  
  3375.  
  3376. Since UDO Release 6 you can call macros with parameters. You  can  set
  3377. the  position  of  the  parameters  in the !macro command by inserting
  3378. `(!1)', `(!2)' till `(!9)'. To call a macro with parameters  you  have
  3379. to write brackets (`[...]') around them.
  3380.  
  3381. The following  small  example  shows  how to use a macro for text that
  3382. shall be printed in bold-italic style:
  3383.  
  3384.      !macro BI (!B)(!I)(!1)(!i)(!b)
  3385.      ...
  3386.      This text is printed (!BI [bold and italic]).
  3387.  
  3388. The "(!1)" in the macro line will be replaced by the words  "bold  and
  3389. italic".
  3390.  
  3391.  
  3392. Please note:
  3393.  
  3394.   1. When  naming  the  macros  you should be cautious not to use pre-
  3395.      defined UDO command names like "B" or "nl". If you don't you will
  3396.      get  problems  with  bold  text  ((!B))  or  the  newline command
  3397.      ((!nl)).
  3398.  
  3399.   2. You shouldn't use too many macros because every additional  macro
  3400.      slows  down the conversion of the source file. The maximum number
  3401.      of macro is 128.
  3402.  
  3403.  
  3404. 6.9.2  Definitions
  3405. ------------------
  3406.  
  3407. Like macros definitions are user-defined  placeholders.  You  can  use
  3408. them  to  insert  special  commands inside the text especially for the
  3409. destination format.
  3410.  
  3411. The syntax is !define <word> <text>. In contrast to macros <text> will
  3412. not  be  converted  in  a  special  way.  No  special  characters  are
  3413. translated inside <text>.
  3414.  
  3415. In this example I will demonstrate how to print headlines with HTML:
  3416.  
  3417.      !ifdest [html]
  3418.        !define H1 <H1>
  3419.        !define h1 </H1>
  3420.      !else
  3421.        !define H1
  3422.        !define h1
  3423.      !endif
  3424.      [...]
  3425.      (!H1)A headline(!h1)
  3426.  
  3427.  
  3428. As you can see you can use definitions to insert special commands that
  3429. aren't  supported  by  UDO.  UDO  Release  4  offered a lot of special
  3430. commands for LaTeX that you now have  to  simulate  with  the  !define
  3431. command:
  3432.  
  3433.      !ifdest [tex]
  3434.        !define ff "ff
  3435.        !define nolb3 \nolinebreak[3]
  3436.        !define lb2 \linebreak[2]
  3437.      !else
  3438.        !define ff ff
  3439.        !define nolb3
  3440.        !define lb2
  3441.      !endif
  3442.      [...]
  3443.      Tell (!LaTeX) a good place
  3444.      (!lb2) for breaking lines.
  3445.  
  3446.  
  3447. You can   use  definitions  with  parameters,  too.  Definitions  with
  3448. parameters are used the same way you can use macros  with  parameters.
  3449. Definitions  with  parameters are a great help to expand UDO's support
  3450. of a destination format.
  3451.  
  3452. You declare definitions like in the upper example. You  can  tell  UDO
  3453. the  positions of the parameters by adding `(!1)', `(!2)' till `(!9)'.
  3454. When you call a definition you have to write brackets (`[...]') around
  3455. the parameters.
  3456.  
  3457. In the  upper example I have shown you how to make a heading for HTML.
  3458. When using parameters it may look like the following example:
  3459.  
  3460.      !ifdest [html]
  3461.        !define head <H1>(!1)</H1>
  3462.      !else
  3463.        !define head (!1)
  3464.      !endif
  3465.      [...]
  3466.      (!head [A headline])
  3467.  
  3468. As you can see in this example you can write format depending commands
  3469. UDO doesn't support already.
  3470.  
  3471. The upper  LaTeX  example  can  be  defined  nicer,  too.  If  you use
  3472. parameters you  can  provide  all  available  LaTeX  commands  in  one
  3473. definition:
  3474.  
  3475.      !ifdest [tex]
  3476.        !define lb \linebreak[(!1)]
  3477.      !else
  3478.        !define lb (!2)
  3479.      !endif
  3480.      [...]
  3481.      Tell (!LaTeX) a good place
  3482.      (!lb [2]) for breaking lines.
  3483.  
  3484. In this   example  only  one  parameter  is  used  but  the  non-LaTeX
  3485. definition contains a second parameter. You may ask  yourself  why  it
  3486. has  to  be  like this. Well, if you call the definition with only one
  3487. parameter the second parameter is empty. When expanding the  non-LaTeX
  3488. definition  UDO will replace the definition placeholder by empty space
  3489. (because there is no second parameter, you understand?). Unfortunately
  3490. you   have   to  use  this  work-around  when  using  definition  with
  3491. placeholders.
  3492.  
  3493.  
  3494. Please note:
  3495.  
  3496.   1. Characters of text of the !define command won't be converted.
  3497.  
  3498.   2. Characters of the parameters you pass to the definition  will  be
  3499.      converted.
  3500.  
  3501.   3. UDO  supports  the !heading command for displaying headlines. The
  3502.      upper HTML example is only used for demonstration.
  3503.  
  3504.   4. When naming the definitions you should be  cautious  not  to  use
  3505.      pre-defined  UDO command names like "B" or "nl". If you don't you
  3506.      will get problems with bold text ((!B)) or  the  newline  command
  3507.      ((!nl)).
  3508.  
  3509.   5. You  shouldn't  use too many definitions because every additional
  3510.      definition slows down the conversion  of  the  source  file.  The
  3511.      maximum number of definitions is 128.
  3512.  
  3513.  
  3514. 6.9.3  Indices
  3515. --------------
  3516.  
  3517. To add  entries  for  the  index you can use the !index command or the
  3518. (!idx ...) placeholder. You can and should use these commands as often
  3519. as possible.
  3520.  
  3521. To add an entry with the !index command use it this way:
  3522.  
  3523.      !index Index entry
  3524.  
  3525. The entry  appears  inside  the  index of LaTeX, inside the index of a
  3526. Texinfo file that was printed with TeX, inside the  index  of  an  ST-
  3527. Guide  hypertext,  inside the search dialog of Windows Help and inside
  3528. the index of an RTF file.
  3529.  
  3530. To insert a multi-index you can separate  the  index  entries  with  a
  3531. double  exclamation mark. You can use up to three indices in one line.
  3532. You should use multi-indices when it's obvious that a potential reader
  3533. looks for an entry in different ways.
  3534.  
  3535. If you  think  that  a  reader might look for "Index entry" or "Entry,
  3536. Index" you should use the following index commands:
  3537.  
  3538.      !index Index entries
  3539.      !index Entry !! Index
  3540.  
  3541.  
  3542. If you  use  the  placeholder  (!idx  ...) you  can  use  up  to  four
  3543. parameters. The following examples show how the commands are converted
  3544. for LaTeX, Windows Help and RTF:
  3545.  
  3546.      UDO:    an (!idx [entry])
  3547.      LaTeX:  an entry\index{entry}
  3548.      Win:    an {K{\footnote K entry}}entry
  3549.      else:   an entry
  3550.      
  3551.      UDO:    a (!idx [word] [entry])
  3552.      LaTeX:  a Wort\index{entry}
  3553.      Win:    a {K{\footnote K entry}}word
  3554.      else:   a Wort
  3555.      
  3556.      UDO:    a (!idx [word] [entry] [subentry])
  3557.      LaTeX:  a word\index{entry!subentry}
  3558.      Win:    a {K{\footnote K entry, subentry}}word
  3559.      else:   a word
  3560.      
  3561.      UDO:    a (!idx [word] [entry] [subentry] [subsubentry])
  3562.      LaTeX:  a word\index{entry!subentry!subsubentry}
  3563.      Win:    a {K{\footnote K entry, subentry, Subsubentry}}word
  3564.      else:   a word
  3565.  
  3566.  
  3567. Please note:
  3568.  
  3569.   1. The conversion of these index commands can be suppressed with the
  3570.      switch !no_index inside the preamble.
  3571.  
  3572.   2. Chapter names, labels and aliases aren't added to the index in no
  3573.      destination  format.  But  you  can  automatize  this  with   the
  3574.      following            switches:           !use_nodes_inside_index,
  3575.      !use_label_inside_index and !use_alias_inside_index.
  3576.  
  3577.   3. If a chapter contains the command !ignore_index the chapter  name
  3578.      won't  be  added  to  the  index  even  if  you  use  the  switch
  3579.      !use_nodes_inside_index inside the preamble of your source file.
  3580.  
  3581.   4. If you convert to LaTeX and you use !index commands  inside  your
  3582.      source  file  UDO  will  add  the commands that are necessary for
  3583.      "Makeindex" automatically. Special characters of an  index  entry
  3584.      are converted especially for "Makeindex".
  3585.  
  3586.   5. You  have  to  use the parameters inside brackets. If you want to
  3587.      use a bracket inside a parameter you have to insert a `!'. If you
  3588.      don't UDO will think that the placeholder ended. An example:
  3589.  
  3590.           wrong:  (!idx [Copyright (c) 1995] )
  3591.           right:  (!idx [Copyright (c!) 1995] )
  3592.  
  3593.  
  3594. 6.9.4  Special commands
  3595. -----------------------
  3596.  
  3597. UDO offers  you  two commands and an environment for every destination
  3598. format that you can use to insert special commands for this format. So
  3599. you  are  able  to insert small passages or huge blocks written in the
  3600. destination format (like special tables for LaTeX or HTML).
  3601.  
  3602. You have to use abbreviations of the destination formates if you  want
  3603. to use these special commands:
  3604.  
  3605.  asc   ASCII
  3606.  aqv   Apple QuickView
  3607.  htag  HP Helptag SGML
  3608.  html  HTML
  3609.  info  Texinfo
  3610.  ldoc  Linuxdoc-SGML
  3611.  lyx   LyX
  3612.  man   Manualpage
  3613.  pch   Pure C Help
  3614.  pdf   PDF
  3615.  rtf   RTF
  3616.  stg   ST-Guide
  3617.  tex   LaTeX
  3618.  tvh   Turbo Vision Help
  3619.  win   Windows Help
  3620.  
  3621. For every  destination  format  UDO  offers a command to insert a line
  3622. with commands for the current destination format,  and  a  command  to
  3623. insert  a  line for all different formats. The commands are built by a
  3624. `!' and the abbreviations or `!=' plus the abbreviation.
  3625.  
  3626. The next example shows how to insert a line that will only be  printed
  3627. for the ASCII format:
  3628.  
  3629.      !asc This line appears only in ASCII.
  3630.  
  3631. The next  example  shows  how  to  insert  a  line that appears in all
  3632. formats except ASCII:
  3633.  
  3634.      !=asc This line doesn't appear in ASCII.
  3635.  
  3636. The contents of the line will  be  printed  without  the  command  and
  3637. without  converting the text of the line. These commands split up text
  3638. into different paragraphs like all the other UDO  commands.  So  these
  3639. commands aren't useful to insert a line into a paragraph!
  3640.  
  3641. You can  use  these  commands to insert special commands like parts of
  3642. the preamble for LaTeX:
  3643.  
  3644.      !tex \documentstyle[11pt,makeidx]{article}
  3645.      !tex \makeindex
  3646.      [...]
  3647.      !tex \printindex
  3648.  
  3649.  
  3650. The raw environment
  3651. -------------------
  3652.  
  3653. But it happens that you want to insert large  passages  only  for  one
  3654. format  with special commands. You could add one of the upper commands
  3655. at the beginning of each line, sure. But to make it easier for you  to
  3656. insert these passages UDO has a special environment for this case: the
  3657. raw environment.
  3658.  
  3659. Together with the possibility to check the current destination  format
  3660. you  can  e.g.  insert complex tables for LaTeX or forms for HTML with
  3661. the raw environment. The following example shows  how  to  enter  HTML
  3662. forms to your source code:
  3663.  
  3664.      !ifdest [html]
  3665.      !begin_raw
  3666.      <FORM method=post action="mailto:DirkHage@aol.com">
  3667.      <PRE>
  3668.      <p>    Name:  <INPUT name="Name" size=60>
  3669.      <p>
  3670.      <p>           <INPUT type=submit value="Send">
  3671.      <p>           <INPUT type=reset value="Reset">
  3672.      </PRE>
  3673.      </FORM>
  3674.      !end_raw
  3675.      !else
  3676.      The HTML version will display a form here.
  3677.      !endif
  3678.  
  3679. To say it once more: Text that is part of a raw environment is printed
  3680. "as is". That means that it's not converted and not indented.  If  you
  3681. will insert the upper form source code into a verbatim environment you
  3682. will see the source code in an HTML browser.  But  if  you  insert  it
  3683. inside a raw environment you will see the form!
  3684.  
  3685.  
  3686. 6.9.5  Split documents
  3687. ----------------------
  3688.  
  3689. UDO offers  you  the  commands !include, !vinclude and !rinclude. With
  3690. these commands you are enabled to split up a document into many  files
  3691. that  are  included  by  a  main  file.  Furthermore you can use these
  3692. commands to include an often used passage that you have to  type  only
  3693. once.
  3694.  
  3695. This documentation  uses  this  commands  intensively.  The file udo.u
  3696. doesn't contain any text and just includes other files. So I have  the
  3697. possibility  to  find  some passages more fast if I have to change the
  3698. documentation.
  3699.  
  3700. You can use !include wherever you want.  So  you  can  define  macros,
  3701. definitions  or syllabification patterns in external files that can be
  3702. used by other files, too.
  3703.  
  3704. For displaying the preformatted contents of a file  you  can  use  the
  3705. !vinclude command  ("verbatim include"). You can use this command e.g.
  3706. for displaying source files or header files.
  3707.  
  3708. If you want to included special commands for a destination format like
  3709. difficult  tables  for LaTeX or HTML you can use the !rinclude command
  3710. ("raw include").
  3711.  
  3712. Possible examples of use:
  3713.  
  3714.   1. When writing large source files you can edit a separate file  for
  3715.      each chapter that are included by a main file with !include. Thus
  3716.      you can restructure your text by simply moving one  line  of  the
  3717.      main file.
  3718.  
  3719.   2. If  you split up your text into several file that are included by
  3720.      a main file you can speed up looking for errors because  you  can
  3721.      simply  switch  off  some parts of the text by commenting out one
  3722.      line of the main file.
  3723.  
  3724.   3. Together with macros you can write standardized  texts  that  you
  3725.      can  use  for  many  projects.  E.g.  you  can  edit  a  standard
  3726.      disclaimer where the name of the software is replaced  by  macros
  3727.      that are defined by the main file.
  3728.  
  3729.   4. A  documentation can be written by different persons. Each author
  3730.      can test his own file with UDO. If  everybody  has  finished  his
  3731.      work all files will be included by a main file.
  3732.  
  3733.   5. With  !vinclude and  !tabwidth you  can  add  source code to your
  3734.      documentation. This is great for a documentation of a source code
  3735.      or a library.
  3736.  
  3737.  
  3738.  
  3739. ======================================================================
  3740. Chapter 7
  3741.  
  3742. Tips & tricks
  3743. ======================================================================
  3744.  
  3745. In this  chapter I will tell you some tips for your writing UDO source
  3746. files. Furthermore I will show you some tricks. Maybe these tricks can
  3747. help you solving some of your problems.
  3748.  
  3749. I'm going to add additional tips in the near future. Watch out for new
  3750. versions of this documentation or for new UDO Releases.
  3751.  
  3752.  
  3753. 7.1  Seven rules for writing UDO source files
  3754. =============================================
  3755.  
  3756. Before starting to write UDO source files you should take  a  look  at
  3757. these rules and learn them by heart:
  3758.  
  3759.   1. Arrange your documentation clearly!
  3760.  
  3761.   2. Speak directly to the reader.
  3762.  
  3763.      Use "You can..." instead of "It's possible to...".
  3764.  
  3765.   3. Use text styles sparingly and homogeneously.
  3766.  
  3767.      Don't use  italic, bold and underlined text too often. But if you
  3768.      use different text styles use them homogeneously. This documenta-
  3769.      tions  prints  all  UDO  command  in  italics,  all filenames are
  3770.      printed with a mono-spaced font.
  3771.  
  3772.   4. Make it brief as possible.
  3773.  
  3774.      Don't write novels, come straight to the point. If you don't  the
  3775.      reader may get bored while reading your manual.
  3776.  
  3777.      I have to admit that I'm not able to do this in some cases. ;-)
  3778.  
  3779.   5. Use short chapter names.
  3780.  
  3781.      If you  use  short chapter names the reader will find the chapter
  3782.      more quickly after having read the table of contents. Furthermore
  3783.      you can help UDO to insert hypertext links more quickly.
  3784.  
  3785.   6. Avoid to use the same chapter name more than once.
  3786.  
  3787.      If you  use  the  same  chapter  name  more than once UDO and the
  3788.      hypertext compilers  get  confused.  And  you  will  confuse  the
  3789.      reader, too.
  3790.  
  3791.   7. Use macros and definitions sparingly.
  3792.  
  3793.      UDO has to look for macros and definitions twice in every line of
  3794.      your source file. Any additional macro or definitions slows  down
  3795.      the conversion.
  3796.  
  3797.  
  3798. 7.2  General tips & tricks
  3799. ==========================
  3800.  
  3801.  
  3802. 7.2.1  Split large documentations
  3803. ---------------------------------
  3804.  
  3805. If you  write a documentation that is 30 KB or larger you should split
  3806. up it into different parts that you can merge with !include.
  3807.  
  3808. By splitting up the documentation you are e.g. enabled to  restructure
  3809. it  by  simply moving one line of your main source file. If your docu-
  3810. mentation is part of one file you have  to  move  blocks  of  text  to
  3811. restructure it.
  3812.  
  3813. Another advantage  is that you can find specific chapters more quickly
  3814. if you write them to files that you name like this chapter.
  3815.  
  3816. Furthermore you can test or convert only some parts of the  documenta-
  3817. tion.  My  be  you  have  a  documentation with five chapters. Write a
  3818. preamble file, a main file and five files that contain the chapters:
  3819.  
  3820.      [main.u]
  3821.      !include header.ui
  3822.      !begin_document
  3823.      !maketitle
  3824.      !tableofcontents
  3825.      !include chapter1.ui
  3826.      !include chapter2.ui
  3827.      !include chapter3.ui
  3828.      !include chapter4.ui
  3829.      !include chapter5.ui
  3830.      !end_document
  3831.      
  3832.      [header.ui]
  3833.      !title ...
  3834.      !program ...
  3835.      !author ...
  3836.      
  3837.      [chapter1.ui]
  3838.      !node Chapter 1
  3839.      ...
  3840.      
  3841.      [chapter2.ui]
  3842.      !node Chapter 2
  3843.      ...
  3844.      
  3845.      [etc]
  3846.  
  3847. If you now want to convert a single chapter you  simply  edit  another
  3848. main file:
  3849.  
  3850.      [ch5test.u]
  3851.      !include header.ui
  3852.      !begin_document
  3853.      !maketitle
  3854.      !tableofcontents
  3855.      !include chapter5.ui
  3856.      !end_document
  3857.  
  3858. If you  use  this  method  you  will be able to find errors in a large
  3859. documentation more quickly.
  3860.  
  3861. Just take a look at the source files of the UDO documentation  if  you
  3862. want to know how to split up a large documentation. You can believe me
  3863. that it would be hard work if all the text would be part of  a  single
  3864. text file.
  3865.  
  3866.  
  3867. 7.2.2  Use standardized source files
  3868. ------------------------------------
  3869.  
  3870. There are  some  authors that write every few weeks a new program or a
  3871. new hypertext. And in every documentation you can read a disclaimer or
  3872. a  copyright  chapter.  Wouldn't it be easier to use the same text all
  3873. the time?
  3874.  
  3875. No problem, just use macros. The following example shows how to use  a
  3876. standardized  copyright text. May be you have a written a program that
  3877. contains this copyright note:
  3878.  
  3879.      ""Hello, World!"" Version 8.15 (!nl)
  3880.      Copyright (!copyright) 1996 by C. Rookie
  3881.  
  3882. Your next program contains a  similar  text,  only  the  name  of  the
  3883. program  and the version number differ. Wouldn't it be better to use a
  3884. standardized text any time  you  write  the  documentation  of  a  new
  3885. software?
  3886.  
  3887.      ""(!PrgName)"" Version (!PrgVersion) (!nl)
  3888.      Copyright (!copyright) (!PrgYear) by C. Rookie
  3889.  
  3890. Here the  name,  the  version number and the years will be replaced by
  3891. the contents of macros "PrgName", "PrgVersion" and "PrgYear".  If  you
  3892. write the upper text to a sinlge file you can use it for many documen-
  3893. tations where only the macros have to be defined.
  3894.  
  3895.      !macro PrgName    Hello, World!
  3896.      !macro PrgVersion 8.15
  3897.      !macro PrgYear    1996
  3898.      ...
  3899.      !begin_document
  3900.      ...
  3901.      !include copyleft.ui
  3902.  
  3903. It's true that this is only a small example. But  you  can  make  more
  3904. complex files if you want to.
  3905.  
  3906.  
  3907. 7.2.3  Write your own commands
  3908. ------------------------------
  3909.  
  3910. UDO doesn't  support  every command of the destination formats. If you
  3911. need a special command you  can  add  it  by  using  definitions  with
  3912. parameters. You only need some knowledge about the destination format.
  3913.  
  3914. The following  example  shows  how  to write commands for changing the
  3915. font size for LaTeX, HTML, Windows Help and RTF:
  3916.  
  3917.      !code_iso
  3918.      !program Changing the font size
  3919.      !author Dirk Hagedorn
  3920.      !date August 19th 1996
  3921.      
  3922.      !ifdest [tex]
  3923.      !define tiny  {\tiny{(!1)}}
  3924.      !define large {\large{(!1)}}
  3925.      !define Large {\Large{(!1)}}
  3926.      !define LARGE {\LARGE{(!1)}}
  3927.      !define huge  {\huge{(!1)}}
  3928.      !define Huge  {\Huge{(!1)}}
  3929.      !endif
  3930.      
  3931.      !ifdest [win,rtf]
  3932.      !define tiny  {\fs14 (!1)}
  3933.      !define large {\fs28 (!1)}
  3934.      !define Large {\fs36 (!1)}
  3935.      !define LARGE {\fs44 (!1)}
  3936.      !define huge  {\fs50 (!1)}
  3937.      !define Huge  {\fs60 (!1)}
  3938.      !endif
  3939.      
  3940.      !ifndest [tex,win,rtf]
  3941.      !macro  tiny  (!2)
  3942.      !macro  large (!2)
  3943.      !macro  Large (!2)
  3944.      !macro  LARGE (!2)
  3945.      !macro  huge  (!2)
  3946.      !macro  Huge  (!2)
  3947.      !endif
  3948.      
  3949.      !begin_document
  3950.      !maketitle
  3951.      !tableofcontents
  3952.      
  3953.      !node Test
  3954.      
  3955.      (!tiny [tiny]),
  3956.      normal,
  3957.      (!large [large]),
  3958.      (!Large [Large]),
  3959.      (!LARGE [LARGE]),
  3960.      (!huge [huge]) und
  3961.      (!Huge [Huge]).
  3962.      
  3963.      !end_document
  3964.  
  3965.  
  3966. 7.3  Tips & tricks according to LaTeX
  3967. =====================================
  3968.  
  3969.  
  3970. 7.3.1  A user-defined LaTeX preamble
  3971. ------------------------------------
  3972.  
  3973. In contrast to the previous UDO version UDO  Release  6  will  save  a
  3974. LaTeX preamble automatically for LaTeX 2.09 or LaTeX2e.
  3975.  
  3976. If you  don't  like the automatically generated preambles you tell UDO
  3977. not to save them by using  the  switch  !no_preamble [tex] inside  the
  3978. preamble of your UDO source file.
  3979.  
  3980. In this case you can enter the special LaTeX commands at the beginning
  3981. of the UDO source file with !tex or a raw environment.
  3982.  
  3983. The following example shows how you can do this:
  3984.  
  3985.      !code_iso
  3986.      !no_preamble [tex]
  3987.      
  3988.      # Uncomment the following line for LaTeX 2.09
  3989.      # !tex \documentstyle[12pt]{article}
  3990.      
  3991.      # Uncomment the following lines for LaTeX2e
  3992.      !tex_2e
  3993.      !tex \documentclass[12pt,a4paper]
  3994.      !tex \usepackage{a4}
  3995.      
  3996.      !begin_document
  3997.      !node Example
  3998.      This example uses a userdefined (!LaTeX) preamble.
  3999.      !end_document
  4000.  
  4001.  
  4002. 7.4  Tips & tricks according to ST-Guide
  4003. ========================================
  4004.  
  4005.  
  4006. 7.4.1  A user-defined title page for ST-Guide
  4007. ---------------------------------------------
  4008.  
  4009. If you don't like the layout of the title  page  UDO  will  make  with
  4010. !maketitle you can make your own title page with some commands:
  4011.  
  4012. The following  example  shows how to make your own title page but only
  4013. for the ST-Guide. It's used a "hidden" node  that  contains  the  word
  4014. "Contents" at the end. The ST-Guide will insert a link to the table of
  4015. contents due to this word.
  4016.  
  4017.      !program Title pages with UDO
  4018.      
  4019.      !begin_document
  4020.      
  4021.      !ifndest [stg]
  4022.      
  4023.      !maketitle
  4024.      
  4025.      !else
  4026.      
  4027.      !node* Title
  4028.      
  4029.      !begin_center
  4030.      The hypertext to ""Hello, World!"" (!nl)
  4031.      Version 8.4
  4032.      
  4033.      written by
  4034.      
  4035.      Ford Prefect
  4036.      !end_center
  4037.      
  4038.      !smallskip
  4039.      
  4040.      !begin_center
  4041.      Contents
  4042.      !end_center
  4043.      
  4044.      !endif
  4045.      
  4046.      !tableofcontents
  4047.      
  4048.      !node The first chapter
  4049.      This is the first chapter
  4050.      
  4051.      !node Bye bye
  4052.      Stop it, now!
  4053.      
  4054.      !end_document
  4055.  
  4056.  
  4057. 7.4.2  Don't use justified text
  4058. -------------------------------
  4059.  
  4060. "Why that?" you might ask. Well, Martin Osieka has written  a  program
  4061. called  Hyperion  for  the  Apple  Macintosh that can display ST-Guide
  4062. hypertexts.
  4063.  
  4064. In contrast  to  ST-Guide  Hyperion  can   display   hypertexts   with
  4065. proportional fonts but only if you don't use justified text.
  4066.  
  4067. Thus you should don't use the justification if you want that Macintosh
  4068. users shall also read your hypertext without any problems.
  4069.  
  4070. If you  have  written  a  system  specific  hypertext  that  is   only
  4071. interesting  for  Atari  users  you  can use justification without any
  4072. doubts.
  4073.  
  4074.  
  4075. 7.5  Tips & tricks concerning Windows Help
  4076. ==========================================
  4077.  
  4078.  
  4079. 7.5.1  Write the source files with a Windows editor
  4080. ---------------------------------------------------
  4081.  
  4082. You can speed up the conversion if you write the source files  with  a
  4083. Windows  editor.  In this case UDO doesn't have to convert the charac-
  4084. ters from the IBM PC character set into  the  Windows  ANSI  character
  4085. set.
  4086.  
  4087. If you  write source file with a Windows Editor you have to insert the
  4088. switch !code_iso inside the preamble  of  your  source  file.  If  you
  4089. forget to do this UDO will think that the source file was written with
  4090. the IBM PC character set.
  4091.  
  4092. Tip: I recommend to use the "Programmer's File Editor"  (PFE)  written
  4093. by  Alan  Phillips,  a  really great freeware editor that is available
  4094. both for Windows 3.11 and Windows95/NT.
  4095.  
  4096.  
  4097. 7.5.2  Compress the Windows Help files
  4098. --------------------------------------
  4099.  
  4100. Using the switch !win_medium_compression or  !win_high_compression you
  4101. can tell the Microsoft Helpcompiler to compress the final Windows Help
  4102. file up to 50%. The Microsoft Helpcompiler will need a little bit more
  4103. time to convert the RTF source file if you use the upper switches.
  4104.  
  4105.  
  4106.  
  4107.  
  4108. ======================================================================
  4109. Appendix A
  4110.  
  4111. Frequently asked questions
  4112. ======================================================================
  4113.  
  4114. This chapter  shall  help you to solve smaller problems. You will find
  4115. some answers to internal questions about  UDO,  too.  In  first  place
  4116. general  questions  are  answered, in second place the format specific
  4117. questions will be answered.
  4118.  
  4119.  
  4120. A.1  General questions
  4121. ======================
  4122.  
  4123.  Why is UDO names `UDO'?
  4124.  
  4125.      When I began programming UDO I had no better idea than naming  it
  4126.      "UDO", the abbreviation for "Universal DOcument".
  4127.  
  4128.      By the way: The author's prename isn't Udo, he's called Dirk!
  4129.  
  4130.  How to I pronounce `UDO'?
  4131.  
  4132.      `UDO' is pronounced like the prename Udo: `Ooh-do'. Pronounce the
  4133.      `U' like the  `u'  in  `butcher',  the  `do'  like  the  `do'  in
  4134.      `document'. Please don't pronounce it like `You do'.
  4135.  
  4136.  How can I get the current versions?
  4137.  
  4138.      You can  download  the  current version from a BBS and via FTP or
  4139.      from the World Wide Web.
  4140.  
  4141.      The current versions are always available in the BBS called "Maus
  4142.      MK2     Iserlohn-Kalthof"    (+49    2371    944925)    in    the
  4143.      "Gruppenprogrammteil UDO.Pub". After  the  login  press  `P'  for
  4144.      `Programmteil',  press  `G'  for  `Gruppenprogrammteil' and enter
  4145.      `UDO.Pub'.  You  can  list   all   archives   by   pressing   `A'
  4146.      (`Ausfנhrliche Liste') and `L' (output list). Remember the number
  4147.      of the archive  and  start  the  download  by  pressing  `D'  and
  4148.      entering the number of the archives.
  4149.  
  4150.      To download  the current version from the World Wide Web open the
  4151.      URL http://members.aol.com/UDODH/index.htm. Here  you  will  find
  4152.      links to the UDO archives.
  4153.  
  4154.      To download    them    via    FTP    open    a    connection   to
  4155.      members.aol.com/UDODH/ (not                ftp.members.aol.com!),
  4156.      members.aol.com/UDOENG/ or members.aol.com/UDOADD/.
  4157.  
  4158.      If you  don't  own  a  modem  and  you  don't  have access to the
  4159.      Internet you can get the current version by simply sending  me  a
  4160.      formatted floppy disk besides a readdressed envelope and 2 DM for
  4161.      stamps. Please tell me which operating system you use.
  4162.  
  4163.      The names of the archives are constructed in the following way:
  4164.  
  4165.           udorlyyy.sss
  4166.              ||| ||  |
  4167.              ||| |+--+--- .zip: ZIP archive
  4168.              ||| |        .tgz: tar gzip archive
  4169.              ||| |
  4170.              ||+-+------- beo:  version for BeOS
  4171.              ||           hp4:  version for HP-UX, 300/400
  4172.              ||           hp8:  version for HP-UX, 700/800
  4173.              ||           lin:  version for Linux
  4174.              ||           mac:  version for MacOS
  4175.              ||           nex:  version for NeXTStep
  4176.              ||           sin:  version for SINIX
  4177.              ||           sun:  version for SunOS
  4178.              ||           tos:  version for Atari ST and clones
  4179.              ||           dos:  version for DOS, OS/2 and Windows
  4180.              ||           man:  source files of this manual
  4181.              ||
  4182.              |+---------- g:    version with German manual
  4183.              |            e:    version with English manual
  4184.              |
  4185.              +----------- Release number: 6 for UDO Rel. 6
  4186.  
  4187.      The archive containing the English version for MS-DOS  is  called
  4188.      udo6edos.zip,  the archive containing the English source files of
  4189.      this manual is called udo6eman.zip.
  4190.  
  4191.      The Unix version may have longer names like udo6_ger_linux.tar.gz
  4192.      or udo6_eng_hp-ux-34.tar.Z.
  4193.  
  4194.  Will there be versions for other operating systems?
  4195.  
  4196.      At the  moment  UDO  is  available  for  the  following operating
  4197.      systems:
  4198.  
  4199.         ⁿ Atari TOS
  4200.         ⁿ BeOS
  4201.         ⁿ DOS, OS/2, Windows
  4202.         ⁿ HP-UX 9.x for 300/400 and 700/800 models
  4203.         ⁿ Linux i86
  4204.         ⁿ MacOS
  4205.         ⁿ NeXTStep
  4206.         ⁿ SINIX
  4207.  
  4208.      UDO was completely written in highly portable C. The source  code
  4209.      doesn't  call any system specific functions. Due to this fact UDO
  4210.      could be ported to any operating system a C compiler is  existing
  4211.      for.
  4212.  
  4213.  Can UDO generate formats from other systems?
  4214.  
  4215.      Sure. E.g. you can run UDO on a Windows PC and save Linuxdoc-SGML
  4216.      files. You can run UDO on a Linux PC and save Windows Help files.
  4217.      No  problem.  UDO has the same functions on any operating systems
  4218.      it's available for.
  4219.  
  4220.      Maybe you have only to convert the file with GNU-Recode later  if
  4221.      the charsets are not the same.
  4222.  
  4223.  Can I write my source files "here" and translate them "there"?
  4224.  
  4225.      Yes, you  can  e.g.  write  your source files on a Windows PC and
  4226.      convert them on  a  BeBox  or  Apple  Macintosh.  UDO  knows  the
  4227.      charsets  of  all  operating  system it's available for. You have
  4228.      only to say UDO which charset was used  for  writing  the  source
  4229.      files by using the commands like !code_iso or !code_mac.
  4230.  
  4231.  Do you want to support other destination formats in the future?
  4232.  
  4233.      Yes, I  want  to  support the following formats if I will get any
  4234.      information about them  and  if  I'm  allowed  to  generate  them
  4235.      without paying any licences to anybody:
  4236.  
  4237.         ⁿ Apple Guide
  4238.         ⁿ HP HelpTag SGML
  4239.         ⁿ OS/2-Help
  4240.         ⁿ Portable Document Format `PDF', Adobe Acrobat Reader
  4241.         ⁿ Postscript
  4242.  
  4243.  May the UDO syntax change in the future?
  4244.  
  4245.      UDO is  that  kind  of  software that is improved day by day. New
  4246.      commands will appear in the future, that's for sure.
  4247.  
  4248.      In some cases it will be necessary to change the syntax  of  some
  4249.      commands.  But  I  will tell you about these changes. Just take a
  4250.      look at the "History" to get to know about  the  changes  in  the
  4251.      past.
  4252.  
  4253.  How does UDO work?
  4254.  
  4255.      UDO reads the source file(s) in two passes.
  4256.  
  4257.      In the  first pass UDO reads in the switches, macros, definitions
  4258.      and the chapter titles that are needed for referencing.
  4259.  
  4260.      In the second pass UDO will convert and layout the text. UDO will
  4261.      save all lines in an internal buffer until it reads an empty line
  4262.      or an UDO command. A command or an empty line tells UDO to layout
  4263.      the last paragraph and to go on reading the source file.
  4264.  
  4265.  How does UDO reference other parts of the document?
  4266.  
  4267.      UDO inserts  links in hypertext formats (except for the ST-Guide)
  4268.      automatically to other parts of the documentation. UDO references
  4269.      chapter titles, labels and aliases.
  4270.  
  4271.      Using the  switch  !autoref [off] you  can tell UDO not to insert
  4272.      any references until you use the switch !autoref [on].
  4273.  
  4274.  How can I link to parts of the current page?
  4275.  
  4276.      Because UDO doesn't insert links to labels of the same  page  you
  4277.      have  to  insert  a  explicit  link  to  this  label by using the
  4278.      (!link [ ] placeholder. An example:
  4279.  
  4280.      !node  Test
  4281.      !label Test top
  4282.      [...]
  4283.      (!link [Back to top of page] [Test top])
  4284.  
  4285.  How can I display images in the table of contents?
  4286.  
  4287.      You have to make your own table of contents, that means you  have
  4288.      to leave the !tableofcontents command. An example:
  4289.  
  4290.           !begin_document
  4291.           !maketitle
  4292.           !node Contents
  4293.           !image foo
  4294.           !toc [all]
  4295.           
  4296.           !node First chapter
  4297.  
  4298.  
  4299. A.2  Questions concerning ASCII
  4300. ===============================
  4301.  
  4302.  Do you plan to split up ASCII manuals into separate files?
  4303.  
  4304.      Only one  (unregistered)  user  has  wished  yet  that UDO should
  4305.      output chapters etc. to separate  files  as  it  does  for  HTML.
  4306.      Because  no one else has asked me to do this yet I haven't imple-
  4307.      mented this feature.
  4308.  
  4309.      But if there's a need for this feature I will implement  it.  The
  4310.      functions still exist and have only to be adapted for ASCII.
  4311.  
  4312.  Some lines are larger than 70 characters, why?
  4313.  
  4314.      These are  the  lines  that  contain  bold,  italic or underlined
  4315.      words. These text styles are generated with the characters  *,  /
  4316.      and _ like in Usenet.
  4317.  
  4318.      Because of  the  existence of some print tools (e.g. IdeaList for
  4319.      Atari ST) and newsreaders know  these  text  styles  UDO  doesn't
  4320.      count these special characters.
  4321.  
  4322.      If you  want  to  suppress the output of these characters you can
  4323.      use the switch !no_effects [asc] inside the preamble.
  4324.  
  4325.  8bit characters are wrong when viewing an ASCII file with Windows!?
  4326.  
  4327.      UDO saves ASCII  files  that  use  the  system  charset  of  your
  4328.      operating  system. UDO is a DOS software, not a Windows software.
  4329.      So it will use the  IBM-PC  charset  and  not  the  Windows  ANSI
  4330.      charset.
  4331.  
  4332.      Just view  the  ASCII files with the System font or Terminal font
  4333.      and you will believe me that the 8bit characters aren't wrong.
  4334.  
  4335.  How can I change the paragraph width?
  4336.  
  4337.      The paragraph width can be changed with the !parwidth command.
  4338.  
  4339.  
  4340. A.3  Questions concerning HTML
  4341. ==============================
  4342.  
  4343.  How can I tell UDO not make files for each chapter?
  4344.  
  4345.      In contrast to the other formats UDO saves a separate  HTML  file
  4346.      for  each  chapter by default. UDO names these files by using the
  4347.      chapter numbers. The title page and the table of contents will be
  4348.      saved in the file you passed in the command line.
  4349.  
  4350.      Using the   switches   !html_merge_nodes,   !html_merge_subnodes,
  4351.      !html_merge_subsubnodes or   !html_merge_subsubsubnodes you   can
  4352.      tell UDO not to save a file for each chapter.
  4353.  
  4354.      If you  use  !html_merge_nodes inside  the preamble UDO will save
  4355.      only one HTML file that contains the whole text. You  should  use
  4356.      this option only for small source files.
  4357.  
  4358.      If you use !html_merge_subnodes UDO will save separate files only
  4359.      for chapters. All  sections,  subsections  and  paragraphs  of  a
  4360.      chapter will be saved inside this file, too.
  4361.  
  4362.      If you  use  !html_merge_subsubnodes UDO will save separate files
  4363.      for chapters and sections. The subsections and  paragraphs  of  a
  4364.      section  will  be saved in the file that contains the text of the
  4365.      upper section.
  4366.  
  4367.      Finally if you use !html_merge_subsubsubnodes the paragraphs of a
  4368.      subsection  will  be  saved in the file that contains the text of
  4369.      the subsection.  UDO  will  save  separate  files  for  chapters,
  4370.      sections and subsections.
  4371.  
  4372.  I don't like the names of the HTML files!
  4373.  
  4374.      Using the   command   !html_name inside   a   chapter,   section,
  4375.      subsection or paragraph you can tell UDO which filename it  shall
  4376.      use instead of using a filename like "01020304.html".
  4377.  
  4378.  How can I suppress these ugly headlines?
  4379.  
  4380.      UDO will  print  on  every HTML page a headline that contains the
  4381.      title of the documentation and hypertext links to  the  previous,
  4382.      next  and  upper  page.  UDO  uses GIF's for these links that are
  4383.      saved by UDO automatically. The  filenames  of  these  GIF's  are
  4384.      udo_lf.gif, udo_rg.gif and udo_up.gif.
  4385.  
  4386.      Using the switch !no_headlines [html] inside the preamble you can
  4387.      tell UDO not to generate these headlines.
  4388.  
  4389.  How can I easily make my own headlines or bottomlines?
  4390.  
  4391.      If you want to make your own headlines or bottomlines you can use
  4392.      macros  at  the  beginning of each chapter. The following example
  4393.      shows how I added  bottomlines  to  my  WWW  pages.  These  pages
  4394.      contain  links  to  the chapters that contain my address, the de-
  4395.      scriptions of my software and links to other web sites.
  4396.  
  4397.       Main file:
  4398.  
  4399.           !ifdest [html]
  4400.           !define HR <hr>
  4401.           !macro  HEAD [ Software | Contact addresses | Links ] (!HR)
  4402.           !macro  FOOT (!I)Dirk Hagedorn - last updated on (!short_today)(!i)
  4403.           !else
  4404.           !define HR
  4405.           !macro  HEAD
  4406.           !macro  FOOT
  4407.  
  4408.       software.ui:
  4409.  
  4410.           !node Software
  4411.           !html_name software
  4412.           (!HEAD)
  4413.           [...]
  4414.           (!FOOT)
  4415.  
  4416.      If you convert the source file to HTML  UDO  expands  the  macros
  4417.      that  contain  the text of the headlines and bottomlines. Because
  4418.      UDO insert links automatically you can jump to the other pages by
  4419.      clicking the entries of the bottomline.
  4420.  
  4421.      If you  don't  convert  to  HTML  empty  macros  are used so that
  4422.      nothing will appear when using (!HEAD) or (!FOOT).
  4423.  
  4424.  Sometimes a table has a frame, sometimes it hasn't!?
  4425.  
  4426.      Unfortunately HTML only allows to  use  tables  with  or  without
  4427.      frames. You cannot use table lines where you want to.
  4428.  
  4429.      To print  a table with a frame you have to add !hline to the line
  4430.      that contains !begin_table. If you don't want a frame  don't  use
  4431.      !hline. That's all.
  4432.  
  4433.  Which suffixes does UDO use for HTML files?
  4434.  
  4435.      By default  UDO  uses the suffix of the --outfile you used in the
  4436.      command line:
  4437.  
  4438.       -o index.htm  .htm
  4439.       -o index.html .html
  4440.       -o INDEX.HTML .HTML
  4441.  
  4442.      If you use the option -o ! UDO uses `.htm' on  operating  systems
  4443.      with  8+3-filenames  and  `.html'  on operating systems with long
  4444.      filenames.
  4445.  
  4446.  The filenames of the URL's are wrong!?
  4447.  
  4448.      If you use UDO on an operating system that doesn't  support  long
  4449.      filenames  but  you have used `--outfile index.html' and you copy
  4450.      the saved `.htm' files to a web server, remember this:
  4451.  
  4452.        1. UDO will try to save `index.html' but TOS and DOS will  name
  4453.           it `index.htm'.
  4454.  
  4455.        2. UDO  will  use  for  all  hypertext links the suffix `.html'
  4456.           because of the suffix of the `outfile'. If you  use  a  HTML
  4457.           browser  for  TOS or DOS this browser will open `index.html'
  4458.           without any problems even  if  there's  only  a  file  named
  4459.           `index.htm'.
  4460.  
  4461.        3. When  copying  the  files to a web server you have to change
  4462.           the suffixes from `.htm' to `.html'. If you will forget this
  4463.           all links will be wrong.
  4464.  
  4465.  
  4466. A.4  Questions concerning manpages
  4467. ==================================
  4468.  
  4469. The Manualpage  is  an  ASCII  format  where  text  styles are made by
  4470. inserting backspace sequences. It's used for short  software  descrip-
  4471. tions for Unix systems. For longer descriptions you should use the GNU
  4472. Texinfo format.
  4473.  
  4474.  How can I set the page length for manpages?
  4475.  
  4476.      You can set the lines each page of a manpage should have with the
  4477.      command !man_lpp ("lpp" means "lines per page").
  4478.  
  4479.  How can I set the program type for manpages?
  4480.  
  4481.      Use the switch !man_type X where "X" is displayed inside brackets
  4482.      in the headlines of the manpage.
  4483.  
  4484.  Why doesn't UDO print a table of contents?
  4485.  
  4486.      It's very unusual to use a table of contents in  a  manpage.  For
  4487.      short  program  description  - you only should use manpages for -
  4488.      tables of contents don't make sense, too.
  4489.  
  4490.  
  4491. A.5  Questions concerning LaTeX
  4492. ===============================
  4493.  
  4494.  How does UDO create the LaTeX preamble?
  4495.  
  4496.      UDO knows which  language  and  which  document  style  you  use.
  4497.      Furthermore  UDO  knows  if  you are using indices or not. So UDO
  4498.      knows enough to create the LaTeX preamble on its own.
  4499.  
  4500.  How can I make files for LaTeX2e?
  4501.  
  4502.      By default UDO saves files for LaTeX 2.09. If you use the  switch
  4503.      !tex_2e inside  the  preamble  UDO will save a preamble and other
  4504.      special commands for LaTeX2e.
  4505.  
  4506.  I want to use a userdefined preamble!?
  4507.  
  4508.      Use the switch !no_preamble [tex] inside the preamble of your UDO
  4509.      source  file and insert the userdefined LaTeX preamble into a raw
  4510.      environment at the beginning of your UDO source file.
  4511.  
  4512.  How can I use LaTeX formulas inside the text?
  4513.  
  4514.      Use a raw environment for complete paragraphs or definitions  for
  4515.      floating text. An example:
  4516.  
  4517.      !ifdest [tex]
  4518.      !define ab2 $(a+b)^2 = a^2 + 2ab + b^2$
  4519.      !else
  4520.      !macro  ab2 (a + b)^2 = a^2 + 2ab + b^2
  4521.      !endif
  4522.      ...
  4523.      The first binomial theorem: (!ab2)
  4524.  
  4525.  How does UDO translate special chars in indices?
  4526.  
  4527.      Special characters are translated especially for makeindex.
  4528.  
  4529.  When I use brackets inside indices a LaTeX error appears!?
  4530.  
  4531.      You have  to use a `}' for any `}' inside an index entry and vice
  4532.      versa. Otherwise LaTeX will print an error message.
  4533.  
  4534.  
  4535. A.6  Questions concerning Linuxdoc-SGML
  4536. =======================================
  4537.  
  4538. In March 1996 I found an article in  the  German  Unix  magazine  "iX"
  4539. about  Linuxdoc-SGML.  It took two hours to download the Linuxdoc-SGML
  4540. archive and to implement this format into UDO. Unfortunately I  didn't
  4541. own a Linux computer and so I wasn't able to test UDO's output.
  4542.  
  4543. Linuxdoc-SGML is  a multiformat converter like UDO. With Linuxdoc-SGML
  4544. you can  convert  SGML  files  into  LaTeX,  RTF,  HTML,  Texinfo  and
  4545. manpages.  But  it's not a lie if I say that UDO is more powerful than
  4546. Linuxdoc-SGML 1.5.
  4547.  
  4548.  The xlist environment is handled like a description environment!?
  4549.  
  4550.      Linuxdoc-SGML doesn't offer an environment like UDO's xlist envi-
  4551.      ronment.  So  UDO is forced to handle it like a description envi-
  4552.      ronment.
  4553.  
  4554.  Linuxdoc-SGML doesn't know Å, why?
  4555.  
  4556.      Add the following line to /usr/lib/linuxdoc-sgml/rep/html/
  4557.      general:
  4558.  
  4559.           <!entity Aring sdata "Å" >
  4560.  
  4561.  
  4562. A.7  Questions concerning Pure C Help
  4563. =====================================
  4564.  
  4565. The Pure C Help format is only useful for the Pure C compiler on Atari
  4566. ST  for  displaying online library descriptions. The format isn't used
  4567. for any other purposes neither on this nor on other computers.
  4568.  
  4569.  How does UDO print the title page and the table of contents?
  4570.  
  4571.      UDO prints a single page that contains both the  title  page  and
  4572.      the  table  of  contents. Because this page can get very long you
  4573.      should use the switch !use_short_toc [pch].
  4574.  
  4575.  How can I suppress the headlines?
  4576.  
  4577.      UDO prints a  headline  on  each  page  automatically.  Headlines
  4578.      contain  the  name  of  the  current chapter and the title of the
  4579.      source file. By clicking the title you can jump to the title page
  4580.      or the table of contents.
  4581.  
  4582.      Using the  switch !no_headlines [pch] you can suppress the output
  4583.      of these headlines.
  4584.  
  4585.  How can I suppress the bottomlines?
  4586.  
  4587.      UDO prints a bottomline on each page automatically  that  contain
  4588.      links  to  the  previous page, next page and upper page. Thus the
  4589.      reader of the online manual is enabled to jump directly to  other
  4590.      pages without returning to the table of contents.
  4591.  
  4592.      Using the   switch  !no_bottomlines [pch] you  can  suppress  the
  4593.      output of these bottomlines.
  4594.  
  4595.  What can I do with the file with the suffix .cmd?
  4596.  
  4597.      UDO saves a command file for the Pure C Help compiler HC.TTP. You
  4598.      have  to  call the HC by passing the name of this command file to
  4599.      get a compiled help file.
  4600.  
  4601.      UDO always overwrites this file. You  have  to  switch  in  write
  4602.      protection if you want to protect your own changes to this file.
  4603.  
  4604.  How do I build a help file for Pure C?
  4605.  
  4606.      UDO saves  two file when converting the source fie foo.u: foo.scr
  4607.      and foo.cmd.
  4608.  
  4609.      To get a Pure C Help file you have to call HC.TTP by passing  the
  4610.      command file foo.cmd:
  4611.  
  4612.           $ e:\purec\hc.ttp foo.cmd
  4613.  
  4614.      Using GEM just drag foo.cmd onto HC.TTP to start the conversion.
  4615.  
  4616.  How can I install this help file?
  4617.  
  4618.      Pure C can display on user defined help file. This file has to be
  4619.      named  USR.HLP and  it  has  to  be  placed  inside  the  Pure  C
  4620.      directory.
  4621.  
  4622.      To install  your  help  file  backup the original USR.HLP, rename
  4623.      your help file to USR.HLP and copy it to the Pure C directory.
  4624.  
  4625.  
  4626. A.8  Questions concerning the Rich Text Format
  4627. ==============================================
  4628.  
  4629. The Rich Text Format (RTF) is used for the  system  wide  exchange  of
  4630. text  files.  This format has a strict definition. New commands can be
  4631. added every time. If a RTF software reads in an unknown command it has
  4632. to ignore it.
  4633.  
  4634. Unfortunately not   all  the  existing  software  ignore  unknown  RTF
  4635. commands, some are interpreting some senseless stuff.  Microsoft  Word
  4636. doesn't  interpret  the  RTF correctly in all cases, even if Microsoft
  4637. has developed the Rich Text Format.
  4638.  
  4639. It's not wrong if I say that RTF is  the  most  misinterpreted  format
  4640. ever known.
  4641.  
  4642.  Why doesn't UDO print a table of contents?
  4643.  
  4644.      I think  you  are the reader of your documentation wants to print
  4645.      it out with a text processor. And it's for sure that you want the
  4646.      correct page numbers inside the table of contents.
  4647.  
  4648.      But UDO cannot know on which page a chapter will be printed. Thus
  4649.      it doesn't print a table of contents when converting to RTF.
  4650.  
  4651.      OK, it wouldn't be a problem to print it but I  think  you  don't
  4652.      want a table of contents without page numbers.
  4653.  
  4654.  Why doesn't UDO include the image data into the RTF file?
  4655.  
  4656.      Because I don't know until today how image data is converted into
  4657.      RTF data. If you can tell me how this is done, please tell it  to
  4658.      me.
  4659.  
  4660.  The output of my text processor is horrible, why?
  4661.  
  4662.      Bad luck.  You  own  a  text  processor  that  cannot  import RTF
  4663.      correctly. UDO strictly pays attention to the RTF definition.  If
  4664.      it's  possible  for  you  to  contact  the  authors  of your text
  4665.      processor send them your RTF file.
  4666.  
  4667.      By the way: I also tried  to  get  contact  to  authors  of  text
  4668.      processors   but   only  one  author  (Christian  Nieber,  R.O.M.
  4669.      logicware, Papyrus) answered my emails. Can you imagine that?
  4670.  
  4671.  8-bit characters aren't imported correctly!?
  4672.  
  4673.      UDO saves RTF files that use  the  Windows  ANSI  character  set.
  4674.      Every  text processor should be able to import RTF files that use
  4675.      the IBM-PC character set, the Macintosh  character  set  and  the
  4676.      Windows   ANSI  character  set.  If  some  8-bit  characters  are
  4677.      displayed incorrectly it's a problem of your text  processor  and
  4678.      not a bug of UDO.
  4679.  
  4680.  Quotes aren't imported correctly, why?
  4681.  
  4682.      UDO uses   the  RTF  commands  \lquote,  \rquote,  \rdblquote and
  4683.      \ldblquote for displaying the typographical quotes  and  apostro-
  4684.      phes. Your text processor has to know these common RTF commands.
  4685.  
  4686.      If it doesn't want to import these RTF commands or the quotes and
  4687.      apostrophes are displayed incorrectly you can tell UDO not to use
  4688.      these  RTF  commands  by  inserting  the  switch !no_quotes [rtf]
  4689.      inside the preamble of the UDO source file.
  4690.  
  4691.  My text processor cannot import tables. What can I do?
  4692.  
  4693.      Use the switch !rtf_ascii_tables inside the preamble of your  UDO
  4694.      source  file  to  tell UDO that it shall print tables without RTF
  4695.      commands like in the ASCII format.
  4696.  
  4697.  StarWriter 3.0 prints an RTF error!?
  4698.  
  4699.      It seems to be that StarWriter 3.0 doesn't know all RTF  commands
  4700.      and  furthermore  it  faults correct RTF commands. Please contact
  4701.      Star Division.
  4702.  
  4703.  Indices aren't imported into StarWriter!?
  4704.  
  4705.      StarWriter 3.0 ignores the RTF command `\xe' which  is  used  for
  4706.      indices.
  4707.  
  4708.  Lotus WordPro places chapter numbers outside the text frame!?
  4709.  
  4710.      I'm sorry  but  I  have  no  idea  why  it  does this. Other text
  4711.      processors display the chapter numbers correctly.
  4712.  
  4713.  Lotus WordPro doesn't display tables correctly!?
  4714.  
  4715.      I don't know why Lotus WordPro doesn't recognize the ending of  a
  4716.      table.  The  table  itself  will  be  displayed incorrectly, too.
  4717.      Please use the switch !rtf_ascii_tables inside  the  preamble  of
  4718.      your UDO source file.
  4719.  
  4720.  WordPad doesn't display tables, why?
  4721.  
  4722.      Because WordPad   cannot   display   tables.   Use   the   switch
  4723.      !rtf_ascii_tables inside the preamble of your UDO source file.
  4724.  
  4725.  
  4726. A.9  Questions concerning ST-Guide
  4727. ==================================
  4728.  
  4729.  Images aren't displayed centred?
  4730.  
  4731.      Get the current ST-Guide version. Since Release 15  the  ST-Guide
  4732.      can center images itself.
  4733.  
  4734.  How does UDO create the title page and the table of contents?
  4735.  
  4736.      The title  page  and the table of contents are displayed inside a
  4737.      special node. The title page node is named "Title". The node that
  4738.      contains the table of contents is named "Main".
  4739.  
  4740.      To let the ST-Guide display the first page of the hypertext (this
  4741.      will be the title page in most cases) just pass the name  of  the
  4742.      hypertext. To let the ST-Guide display the table of contents pass
  4743.      the node name "Main". How you can call the ST-Guide from programs
  4744.      you can read in the HCP hypertext.
  4745.  
  4746.  How can I suppress the headlines?
  4747.  
  4748.      UDO prints  a  headline  in  every  page by default. The headline
  4749.      contains the current node name and the title  of  the  hypertext.
  4750.      The headline will be displayed underlined.
  4751.  
  4752.      Using the switch !no_headlines [stg] inside the preamble you tell
  4753.      UDO not to create these headlines.
  4754.  
  4755.  How does UDO insert hypertext links?
  4756.  
  4757.      UDO just insert hypertext  links  when  you  use  (!link ...) and
  4758.      (!xlink ...).  All  the other hypertext links will be inserted by
  4759.      the HCP.
  4760.  
  4761.  How does UDO convert labels?
  4762.  
  4763.      The UDO command  !label will  be  replaced  by  the  HCP  command
  4764.      "@symbol  ari". You have to check yourself if there's a node or a
  4765.      label existing with the same name.
  4766.  
  4767.  How can I make popup nodes?
  4768.  
  4769.      Using the !pnode and the familiar commands you can tell  the  ST-
  4770.      Guide  to  display  the  contents of the node inside a dialog box
  4771.      instead of a window.
  4772.  
  4773.      But you have to remember that text inside a popup node  may  have
  4774.      up  to  12  lines  of  text  with  60  characters  per line only.
  4775.      Furthermore no images and links are allowed inside a popup node.
  4776.  
  4777.      UDO breaks line after 60 characters but it doesn't print an error
  4778.      message  if  you use more than 12 lines, images or links inside a
  4779.      popup node.
  4780.  
  4781.  There's always an empty line at the end of a popup node, why?
  4782.  
  4783.      UDO reads in the source file line  by  line.  If  an  empty  line
  4784.      appears  UDO  will print the last paragraph and an empty line for
  4785.      separation.
  4786.  
  4787.      UDO does the same when printing the text of  a  popup  node.  The
  4788.      problem cannot be solved, I'm sorry.
  4789.  
  4790.  Some cells of my table are too wide, why?
  4791.  
  4792.      The ST-Guide  has a built-in italic correction which is active in
  4793.      tables, too. Unfortunately the ST-Guide  adds  a  blank  when  it
  4794.      reads  an  italic-off command. This problem can only be solved by
  4795.      Holger Weets, the author of ST-Guide.
  4796.  
  4797.      Thus you shouldn't use italic text inside tables when  converting
  4798.      to  ST-Guide  until  Holger doesn't offer a command for disabling
  4799.      the italic correction.
  4800.  
  4801.  The HCP prints the error message "please add...", why?
  4802.  
  4803.      If the HCP prints the  error  message  "please  add  a  @subject-
  4804.      command  to  this text" at the end of converting the STG file you
  4805.      have forgotten to insert a line like the  following  one  at  the
  4806.      beginning of your UDO source file:
  4807.  
  4808.           !stg @subject "Documentation/Utilities"
  4809.  
  4810.  
  4811. A.10  Questions concerning Texinfo
  4812. ==================================
  4813.  
  4814. GNU Texinfo  is  used on many Unix systems to offer the user an online
  4815. hypertext manual and a printed documentation that  can  be  made  with
  4816. `Makeinfo' or plain TeX. Online manuals can be displayed with `Info'.
  4817.  
  4818. On systems with 8+3-filenames UDO saves files with the suffix .tex. If
  4819. the operating systems supports long  filenames  UDO  uses  the  suffix
  4820. .texi instead.
  4821.  
  4822.  Why does UDO change the chapter names?
  4823.  
  4824.      Makeinfo and/or  Info  get  problems  if a chapter names contains
  4825.      brackets, commas or colons. UDO is forced to delete these charac-
  4826.      ters so that you will be able to convert the output with Makeinfo
  4827.      without any problems. If a chapter name contains  only  forbidden
  4828.      characters UDO encodes them.
  4829.  
  4830.      You will  only  see  the  changed  chapter  names inside the Info
  4831.      headlines and Info menus. If you convert the  Texinfo  file  with
  4832.      TeX you will get your original chapter names.
  4833.  
  4834.  Why doesn't Texinfo display the environments in "compressed" form?
  4835.  
  4836.      Using Texinfo  it's  impossible  to smaller the paragraph separa-
  4837.      tion. Thus the parameter !short is  useless  when  converting  to
  4838.      Texinfo.
  4839.  
  4840.  
  4841. A.11  Questions concerning Turbo Vision Help
  4842. ============================================
  4843.  
  4844. This format  is  used to make online manuals for DOS programs that are
  4845. compiled with Borland's Turbo Vision library. UDO's output has  to  be
  4846. converted  with TVHC.EXE. The source code of TVHC.EXE is available and
  4847. you have to change some parts because it contains some bugs.
  4848.  
  4849. If you aren't an author that programs software  that  uses  the  Turbo
  4850. Vision library you shouldn't use this format.
  4851.  
  4852.  TVHC prints the error message "Unterminated topic reference"!?
  4853.  
  4854.      My TVHC  version  1.0  contains  an ugly bug. Due to this bug you
  4855.      cannot quote brackets by using them twice. If  your  TVHC  prints
  4856.      the  upper error message look for the function scanForCrossRefs()
  4857.      in tvhc.cpp and patch it like this:
  4858.  
  4859.      Original version:
  4860.  
  4861.           if (line[i+1] == begXRef)
  4862.           {
  4863.               strdel(line, i, 1);
  4864.                   ++i;
  4865.           }
  4866.  
  4867.      Patched version:
  4868.  
  4869.           if (line[i] == begXRef)    // [i] instead of [i+1]
  4870.           {
  4871.               strdel(line, i, 1);
  4872.                   ++i;
  4873.           }
  4874.  
  4875.      After having changed the source code you should recompile TVHC to
  4876.      enable the changes.
  4877.  
  4878.  TVHC prints the error message "Text too long"!?
  4879.  
  4880.      The file  tvhc.h contains a constant number named bufferSize that
  4881.      defines the maximum size of the text buffer. This text buffer  is
  4882.      a  little  bit small. You should increase the buffer size e.g. to
  4883.      32 KB to suppress the upper error message:
  4884.  
  4885.           const bufferSize = 32768;
  4886.  
  4887.      After having changed the buffer size you should recompile TVHC to
  4888.      enable the changes.
  4889.  
  4890.  TVHC prints the error message "TOPIC expected"!?
  4891.  
  4892.      This error  message is printed if a line starts with a point. The
  4893.      point is a special character in Turbo Vision Help if  it  is  the
  4894.      first character of a line. My TVHC stops if it reads such a line.
  4895.  
  4896.      But there's  no  need to stop the conversion. Thus I have patched
  4897.      my TVHC. I have replaced this line
  4898.  
  4899.           error("TOPIC expected");
  4900.  
  4901.      with
  4902.  
  4903.           warning("TOPIC expected");
  4904.  
  4905.      If you recompile the TVHC it will print a warning and it will  go
  4906.      on  converting  the  source  file  instead  of  printing an error
  4907.      message.
  4908.  
  4909.  
  4910. A.12  Questions concerning Windows Help
  4911. =======================================
  4912.  
  4913.  WinHelp says that the RTF-File isn't a Windows Help file. Why?
  4914.  
  4915.      The RTF file UDO saves isn't a Windows Help file. It's  just  the
  4916.      source  code  of  a  Windows  Help file! You have to convert this
  4917.      source code with the Microsoft Helpcompiler to get a Windows Help
  4918.      file.
  4919.  
  4920.  Where can I get the Microsoft Helpcompiler?
  4921.  
  4922.      You can   download   the   Microsoft  Helpcompiler  HC31.EXE from
  4923.      Microsoft's FTP server (ftp.microsoft.com) free  of  charge.  You
  4924.      shall find the HC where UDO is available, too.
  4925.  
  4926.  Why doesn't want the HC to compile UDO's output?
  4927.  
  4928.      This can have two reasons:
  4929.  
  4930.        1. The  UDO  source file contains errors. Please take a look at
  4931.           UDO's log file (suffix `.ulw') and correct  the  errors  you
  4932.           will  find  there. If the log file doesn't contain any error
  4933.           messages your source file  may  contain  errors  UDO  hasn't
  4934.           detected.
  4935.  
  4936.        2. The HC is working incorrectly. Take a look at the HC's error
  4937.           file (suffix `.err'). Unfortunately I  can't  tell  you  the
  4938.           sense of the errors printed in the error file in most cases.
  4939.  
  4940.  What is the file `.hpj' good for?
  4941.  
  4942.      When converting  to  Windows Help UDO will save an RTF file and a
  4943.      project file for the Microsoft  Helpcompiler  named  `.hpj'.  You
  4944.      have  to start the HC by passing the name of this project file to
  4945.      get a Windows Help file.
  4946.  
  4947.      This project file contains several information e.g. the title  of
  4948.      the  help  file,  code for adding additional buttons, the size of
  4949.      the main window when opening the help file.
  4950.  
  4951.      UDO will overwrite this project file  without  previously  asking
  4952.      you  if you want it. So, if you have changed the project file and
  4953.      you want to protect your changes you have to  write  protect  the
  4954.      project file.
  4955.  
  4956.  How does UDO generate headlines?
  4957.  
  4958.      UDO prints on every page (without the title page and the table of
  4959.      contents) a headline.  In  this  headline  the  chapter  name  is
  4960.      printed  inside  a  non-scrolling region. Thus you can see always
  4961.      the chapter name even if you scroll the text.
  4962.  
  4963.      If you use the switch !no_headlines [win] inside the preamble  no
  4964.      headlines will be printed.
  4965.  
  4966.      If you  use the command !ignore_headline inside a chapter in this
  4967.      chapter no headline will be printed.
  4968.  
  4969.  How does UDO create the context strings?
  4970.  
  4971.      If you want to create a link from another help file or a  program
  4972.      to  a  help  file that was made with UDO you have to know how UDO
  4973.      creates the context strings.
  4974.  
  4975.      Windows Help doesn't  allow  to  use  special  characters  inside
  4976.      context strings. UDO creates the context strings in the following
  4977.      way:
  4978.  
  4979.        1. Special characters are printed in RTF form.
  4980.  
  4981.        2. Blanks will be replaced by underscores.
  4982.  
  4983.        3. All other characters except  numbers  and  letters  will  be
  4984.           replaced   by   their   hexadecimal  value  with  a  leading
  4985.           underscore.
  4986.  
  4987.      An example with German words:
  4988.  
  4989.           UDO:     !node LaTeX-Einfנhrung Teil 1
  4990.           WinHelp: #{footnote # LaTeX_2DEinf_5C_27FChrung_Teil_1}
  4991.  
  4992.      Description:
  4993.  
  4994.        1. The hexadecimal ASCII code of the dash is `0x2D'.  The  dash
  4995.           will be replaced by `_2D'.
  4996.  
  4997.        2. The  `נ'  inside  `Einfנhrung'  is printed in RTF files like
  4998.           `\'FC'. The ASCII code of the backslash (`\') is `0x5C',  so
  4999.           the  backslash  will be replaced by `_5C'. The ASCII code of
  5000.           `'' is `0x27', so the apostrophe will be replaced by `_27'.
  5001.  
  5002.        3. The blanks will be replaced by `_'
  5003.  
  5004.      Thus the single letter "נ" will be replaced by  the  really  long
  5005.      string  `_5C_27FC' wird. Maybe you want to say that this is quite
  5006.      awkward but if UDO would simply replace the "נ" by "FC"  problems
  5007.      would  appear  very soon. Using the upper way the chance that UDO
  5008.      creates a context string that is already used is very small.
  5009.  
  5010.  Why doesn't UDO center tables?
  5011.  
  5012.      It's impossible to center table in Windows Help.
  5013.  
  5014.  Why are there no lines inside tables?
  5015.  
  5016.      Windows Help doesn't allow it to layout complex  tables  like  in
  5017.      RTF.  It's  impossible  to tell Windows Help where to draw lines.
  5018.      It's only possible to tell Windows Help to print table cells with
  5019.      or without frames.
  5020.  
  5021.  Indents in lists and cells in tables are too width, why?
  5022.  
  5023.      UDO doesn't know the width of the characters you use inside lists
  5024.      and tables. Thus UDO is forced to calculate with values  so  that
  5025.      even  bold and italic capital letters will fit the cells. I think
  5026.      that it's better to have cells with a width  that  is  too  large
  5027.      than too small.
  5028.  
  5029.  How can I print graphic characters from the IBM-PC character set?
  5030.  
  5031.      Sorry, there's no way to print them.
  5032.  
  5033.      I don't  know  the  reason  but  Windows Help won't use the fonts
  5034.      "Terminal" or "MS LineDraw". Windows Help will always use another
  5035.      font  if you want to use the upper fonts that contain the graphic
  5036.      characters.
  5037.  
  5038.      Thus UDO will  replace  the  graphic  characters  of  the  IBM-PC
  5039.      character set by "+", "-" or "|".
  5040.  
  5041.  
  5042.  
  5043. ======================================================================
  5044. Appendix B
  5045.  
  5046. Bugs
  5047. ======================================================================
  5048.  
  5049. The following known bugs will be fixed as fast as possible:
  5050.  
  5051.  Text styles inside indices: Inside indices you cannot use text styles
  5052.      at the moment. You can avoid this problem of  you  use  the  text
  5053.      style commands outside the (!idx ...) placeholder.
  5054.  
  5055.  Images & emTeX: The  output  of LaTeX commands for displaying MSP and
  5056.      PCX images with emTeX wasn't tested enough. If you have  problems
  5057.      printing  the  images  use the switch !no_images [tex] inside the
  5058.      preamble and write your own commands inside a raw environment.
  5059.  
  5060.  Small mistakes when layouting WinHelp: If you use many  chapters  and
  5061.      the  chapter numbers become "too wide" there may be wrong indents
  5062.      in the tables of contents. You can avoid this by using the switch
  5063.      !no_numbers [win] in the preamble.
  5064.  
  5065.  Tables of contents: In  the  tables  of  contents long chapter titles
  5066.      aren't sized to the current document width  yet.  Chapter  titles
  5067.      may also appear in different columns ("1.9"-"1.10" problem).
  5068.  
  5069. If you  detect  another  bug  please  let me (see "Contact addresses")
  5070. know. Please add the following details to your bug report:
  5071.  
  5072.    ⁿ Which UDO version do you use?
  5073.  
  5074.    ⁿ On which operating system do you use UDO?
  5075.  
  5076.    ⁿ Does the bug appear every time or only sometimes?
  5077.  
  5078.    ⁿ Do you have an idea why UDO is working incorrectly?
  5079.  
  5080.    ⁿ Can you give me a short example where I can reproduce the bug?
  5081.  
  5082.    ⁿ If the error is format specific what  do  you  think  UDO  should
  5083.      output?
  5084.  
  5085.  
  5086.  
  5087. ======================================================================
  5088. Appendix C
  5089.  
  5090. Error messages
  5091. ======================================================================
  5092.  
  5093. UDO prints  all  error  messages,  warnings and hints that appear when
  5094. converting the source file to files with the suffix .ul?. Each message
  5095. is constructed the following way:
  5096.  
  5097.        Error: <file> <line number>: <text>
  5098.      Warning: <file> <line number>: <text>
  5099.         Hint: <file> <line number>: <text>
  5100.  
  5101. If you want to avoid these errors, warnings and hints open the printed
  5102. file, go to the printed line and try to find the error. Start with the
  5103. first  printed error and convert your source file once again. A lot of
  5104. messages will disappear because they depend on earlier errors.
  5105.  
  5106.  `...' called twice
  5107.  
  5108.      The printed command was used twice or more inside the source file
  5109.      even if it's only to use it once.
  5110.  
  5111.  `...' expected
  5112.  
  5113.      UDO has  expected  the printed command. Please check if all envi-
  5114.      ronments were finished with the correct command or if a  !begin_*
  5115.      is missing.
  5116.  
  5117.  `...' followed by `...'
  5118.  
  5119.      You have finished an environment with an incorrect command or you
  5120.      have forgotten to finish it. Another possibility is that you have
  5121.      misplaced the !end_* command.
  5122.  
  5123.  `...' ignored inside preamble
  5124.  
  5125.      It's only allowed to use the printed command inside the main part
  5126.      of the source file.  That  means  you  have  to  place  it  after
  5127.      !begin_document.
  5128.  
  5129.  `...' ignored outside preamble
  5130.  
  5131.      It's only  allowed to use the printed command inside the preamble
  5132.      of the source file. That  means  you  have  to  place  it  before
  5133.      !begin_document.
  5134.  
  5135.  `...' maybe not available in LaTeX
  5136.  
  5137.      The printed character cannot be used for LaTeX. Please try to use
  5138.      another character.
  5139.  
  5140.  `...' not active
  5141.  
  5142.      A text style or a footnote shall be finished  even  if  it  isn't
  5143.      active.  Please  note  that  the  placeholders  contain a capital
  5144.      letter for activating a text style. The placeholders that  finish
  5145.      a text style contain a small letter.
  5146.  
  5147.  `...' not available in ISO Latin 1
  5148.  
  5149.      ISO Latin1  doesn't  contain  the  printed  character.  Thus, UDO
  5150.      cannot convert the printed character.
  5151.  
  5152.  `...' not available in this charset
  5153.  
  5154.      The printed character isn't available  in  the  system  character
  5155.      set. Thus, UDO cannot convert it. Please try to avoid the printed
  5156.      character.
  5157.  
  5158.  `...' still active
  5159.  
  5160.      A text style or a footnote shall be started even  if  it's  still
  5161.      active.  Please  note  that  the  placeholders  contain a capital
  5162.      letter for activating a text style. The placeholders that  finish
  5163.      a text style contain a small letter.
  5164.  
  5165.  `...' without `...'
  5166.  
  5167.      You wanted  to  finish  an  environment even if it wasn't startet
  5168.      before.
  5169.  
  5170.  !else without !if
  5171.  
  5172.      You have used the !else command but you haven't startet  a  query
  5173.      with !if, !ifdest etc.
  5174.  
  5175.  !endif without !if
  5176.  
  5177.      Your source  file  contains  an  !endif command  but  you haven't
  5178.      startet a query with !if, !ifdest etc.
  5179.  
  5180.  `!item' outside environment
  5181.  
  5182.      You have  used  the   !item command   outside   an   itemization,
  5183.      enumeration, description or list.
  5184.  
  5185.  check this paragraph
  5186.  
  5187.      UDO prints  a  filename  and a line number where you can find the
  5188.      reason for the upper printed error message.
  5189.  
  5190.  couldn't open <file> (pass1)
  5191.  
  5192.      UDO couldn't open the printed file in the first of two passes.
  5193.  
  5194.  couldn't open <file> (pass2)
  5195.  
  5196.      UDO couldn't open the printed file in  the  second  pass.  Please
  5197.      check the filename you have used for !include.
  5198.  
  5199.  couldn't open destination file
  5200.  
  5201.      UDO couldn't open the destination file. Please check the filename
  5202.      or remove file protection of the existing file.
  5203.  
  5204.  couldn't open hypfile
  5205.  
  5206.      UDO couldn't open the hyphenation file. Please check the filename
  5207.      or remove file protection of the existing file.
  5208.  
  5209.  couldn't open logfile
  5210.  
  5211.      UDO couldn't  open  the  log  file.  Please check the filename or
  5212.      remove file protection of the existing file.
  5213.  
  5214.  couldn't open source file
  5215.  
  5216.      UDO couldn't open the source file. Please check the filename.
  5217.  
  5218.  couldn't open treefile
  5219.  
  5220.      UDO couldn't open the tree file. Please  check  the  filename  or
  5221.      remove file protection of the existing file.
  5222.  
  5223.  couldn't read BMP header
  5224.  
  5225.      The printed  file  isn't  a  Windows  Bitmap  or the file doesn't
  5226.      exist.
  5227.  
  5228.  couldn't read IMG header
  5229.  
  5230.      The printed file isn't a GEM image or the file doesn't exist.
  5231.  
  5232.  couldn't read MSP header
  5233.  
  5234.      The printed file isn't a MSP image or the file doesn't exist.
  5235.  
  5236.  couldn't read PCX header
  5237.  
  5238.      The printed file isn't a PCX image or the file doesn't exist.
  5239.  
  5240.  couldn't replace (!ilink ...)
  5241.  
  5242.      A manual image link couldn't be replaced. You are allowed to  use
  5243.      up  to 200 internal and external links and internal images inside
  5244.      each paragraph. Split up the paragraph in two or  more  parts  or
  5245.      delete some links.
  5246.  
  5247.  couldn't replace (!img ...)
  5248.  
  5249.      An internal image couldn't be replaced. You are allowed to use up
  5250.      to 200 internal and external links  and  internal  images  inside
  5251.      each  paragraph.  Split  up the paragraph in two or more parts or
  5252.      delete some links.
  5253.  
  5254.  couldn't replace (!link ...)
  5255.  
  5256.      A manual link couldn't be replaced. You are allowed to use up  to
  5257.      200  internal  and external links and internal images inside each
  5258.      paragraph. Split up the paragraph in two or more parts or  delete
  5259.      some links.
  5260.  
  5261.  couldn't replace (!xlink ...)
  5262.  
  5263.      An external  link couldn't be replaced. You are allowed to use up
  5264.      to 200 internal and external links  and  internal  images  inside
  5265.      each  paragraph.  Split  up the paragraph in two or more parts or
  5266.      delete some links.
  5267.  
  5268.  couldn't write IMG header
  5269.  
  5270.      UDO couldn't  open  the  printed  file  for  changing  the  image
  5271.      information.   Maybe   the  file  doesn't  exist  or  it's  write
  5272.      protected.
  5273.  
  5274.  definition contents longer than ... characters
  5275.  
  5276.      The contents of a definition exceeds the maximum number of  char-
  5277.      acters. Please shorten your definition contents.
  5278.  
  5279.  definition name longer than ... characters
  5280.  
  5281.      The name  of  a  definition exceeds the maximum number of charac-
  5282.      ters. Please shorten your definition name.
  5283.  
  5284.  language ... not supported
  5285.  
  5286.      The printed language isn't supported  by  UDO  yet  or  you  have
  5287.      written the language in a wrong way.
  5288.  
  5289.  link destination undefined
  5290.  
  5291.      The destination  of  a  manual  link  isn't  defined.  That means
  5292.      there's no chapter or label exisiting with the given name.
  5293.  
  5294.  macro contents longer than ... characters
  5295.  
  5296.      The contents of a macro exceeds the maximum number of characters.
  5297.      Please shorten your macro contents.
  5298.  
  5299.  macro name longer than ... characters
  5300.  
  5301.      The contents of a macro exceeds the maximum number of characters.
  5302.      Please shorten your macro name.
  5303.  
  5304.  memory allocation failed
  5305.  
  5306.      UDO couldn't  allocate  the  needed  memory.  It   doesn't   stop
  5307.      converting the source file but you should take a look at the des-
  5308.      tination file if it's OK.
  5309.  
  5310.  missing parameter(s)
  5311.  
  5312.      A command needs a specific numer of parameters and you have  used
  5313.      not  enough  parameters.  Check  the  command  and add the needed
  5314.      parameters.
  5315.  
  5316.  odd number of ''
  5317.  
  5318.      The source file contains an odd number of double apostrophes. UDO
  5319.      will find this error at the end of a chapter so check the chapter
  5320.      above the printed line number.
  5321.  
  5322.  odd number off ""
  5323.  
  5324.      The source file contains an odd number of double quotes. UDO will
  5325.      find  this  error  at  the  end of a chapter so check the chapter
  5326.      above the printed line number.
  5327.  
  5328.  overfull line
  5329.  
  5330.      A line of a verbatim environment is  longer  than  the  value  of
  5331.      !parwidth. Try to cut the line or increase the paragraph width.
  5332.  
  5333.  source and destination file are equal
  5334.  
  5335.      You have  tried  to  read  and  write  the  same file. Check your
  5336.      command line options.
  5337.  
  5338.  string buffer overflow
  5339.  
  5340.      Please contact the author.
  5341.  
  5342.  too many aliases used
  5343.  
  5344.      Your source file contains too many !alias commands. Please delete
  5345.      some  unimportant  aliases or contact the author to get a special
  5346.      version of UDO.
  5347.  
  5348.  too many columns used
  5349.  
  5350.      Your source file contains a table with too many columns.
  5351.  
  5352.  too many defines used
  5353.  
  5354.      Your source file contains more than 128 definitions.
  5355.  
  5356.  too many environments used
  5357.  
  5358.      You have used too many environments  into  one  another.  Try  to
  5359.      layout your source file less complex.
  5360.  
  5361.  too many files opened
  5362.  
  5363.      During the  conversion  too  many  files  were opened. Check your
  5364.      source file if you constructed a recursive include.
  5365.  
  5366.  too many hyphens used
  5367.  
  5368.      Your source file  contains  too  many  syllabification  patterns.
  5369.      Delete some of them and use local syllabification marks.
  5370.  
  5371.  too many items inside enumeration
  5372.  
  5373.      You have  used  too  many  items  inside an enumerate environment
  5374.      where items are marked with letters. Reduce the ammount of  items
  5375.      to 26 or use an itemize environment instead.
  5376.  
  5377.  too many labels used
  5378.  
  5379.      Your source  file  contains too many !label commands. Because UDO
  5380.      handles chapters and aliases like labels, too, this error message
  5381.      can  appear  when  using  only  some  labels.  Please delete some
  5382.      unimportant labels or aliases or contact  the  author  to  get  a
  5383.      special version of UDO.
  5384.  
  5385.  too many macros used
  5386.  
  5387.      Your source file uses more than 128 macros.
  5388.  
  5389.  too many nodes used
  5390.  
  5391.      Your source file uses too many chapters. If possible try to merge
  5392.      some chapters or contact the author to get a special  version  of
  5393.      UDO.
  5394.  
  5395.  too many parameters used
  5396.  
  5397.      A command  or  placeholder  was  called with too many parameters.
  5398.      Check the command and look for additional information inside  the
  5399.      command index.
  5400.  
  5401.  too many rows used
  5402.  
  5403.      Your source file uses a table with too many rows.
  5404.  
  5405.  too many words used inside paragraph
  5406.  
  5407.      A paragraph of your source file uses too many words. Try to split
  5408.      up the paragraph into two or more parts.
  5409.  
  5410.  underfull line
  5411.  
  5412.      The printed line is too short and you  will  see  an  ugly  right
  5413.      margin.  If  you  use  justification this error message says that
  5414.      there were inserted too many blanks.  Try  to  insert  syllabifi-
  5415.      cation  marks or use the !sloppy command to suppress this type of
  5416.      error message.
  5417.  
  5418.  unexpected end of line in command
  5419.  
  5420.      Your source file contains  a  placeholder  that  wasn't  finished
  5421.      correctly.
  5422.  
  5423.  unknown command
  5424.  
  5425.      UDO doesn't know the printed command. If you want to use a word a
  5426.      the beginning of a line that begins with an exclamation mark  you
  5427.      have to mark it with a slash (`/').
  5428.  
  5429.  use (!V) and (!v) in one line
  5430.  
  5431.      Something's still missing here...
  5432.  
  5433.  use (!xlink [text] [topic@foo.hlp])
  5434.  
  5435.      The construction   of  an  external  link  for  Windows  Help  is
  5436.      incorrect.
  5437.  
  5438.  wrong number of parameters
  5439.  
  5440.      You called a command or placeholder  with  the  wrong  number  of
  5441.      parameters. Check the command index for additional information.
  5442.  
  5443.  xlink needs WinHelp destination topic
  5444.  
  5445.      The construction   of  an  external  link  for  Windows  Help  is
  5446.      incorrect. Here the name of the page is missing.
  5447.  
  5448.  xlinks needs WinHelp destination file
  5449.  
  5450.      The construction  of  an  external  link  for  Windows  Help   is
  5451.      incorrect. Here, the name of the Windows Help file is missing.
  5452.  
  5453.  
  5454.  
  5455. ======================================================================
  5456. Appendix D
  5457.  
  5458. This & that
  5459. ======================================================================
  5460.  
  5461.  
  5462. D.1  Facts, facts, facts
  5463. ========================
  5464.  
  5465. You can use source files that don't exceed these maximum values:
  5466.  
  5467.  Macros:                              128
  5468.  Defines:                             128
  5469.  Hyphenation patterns:                4096
  5470.  Sum of chapters, labels and aliases: 6144
  5471.  Characters per line:                 512
  5472.  Characters per word:                 128
  5473.  Syllables per word:                  32
  5474.  Words per paragraph:                 800
  5475.  Links per paragraph:                 200
  5476.  Rows per table:                      256
  5477.  Columns per table:                   32
  5478.  Depth of environments:               6
  5479.  
  5480.  
  5481. Do you know how much work it has been to program UDO and to write this
  5482. documentation? Here's the answer:
  5483.  
  5484.  Source code:           820 KB
  5485.  German Documentation:  470 KB
  5486.  English Documentation: 420 KB
  5487.  
  5488.  
  5489. D.2  Programming environment
  5490. ============================
  5491.  
  5492. UDO has been developed using the following software:
  5493.  
  5494.  Atari:     Pure C 1.1, Pure Profiler 1.0,  MiNT-Libs  PL  46,  SysGem
  5495.             2.03beta,  Interface  2.3,  Programming Tools by Julian F.
  5496.             Reschke, MagiC-PC 1.01
  5497.  
  5498.  DOS:       EMX-GCC 2.6.3 emxfix06, GDB 4.13, PFE
  5499.  
  5500.  HP-UX:     GCC 2.7.2
  5501.  
  5502.  Linux:     GCC 2.7.2, S.u.S.E. Linux 4.3 Kernel 2.0.18, Joe
  5503.  
  5504.  Macintosh: CodeWarrior 9 (68K/PPC), ResEdit 2.1
  5505.  
  5506. Currently I develop UDO on a Pentium 133 running Windows 95  with  the
  5507. EMX-GCC and on my Compaq Contura 486-DX50 notebook running Linux.
  5508.  
  5509.  
  5510.  
  5511. This documentation has been written with the following software:
  5512.  
  5513.    ⁿ Joe Allan's Own Editor `Joe' for MS-DOS and Linux
  5514.    ⁿ Allan  Phillips' Programmer's File Editor `PFE' 0.06.01 (the best
  5515.      editor for Windows 3.1 and Windows 95 I know)
  5516.    ⁿ Phoenix for Windows 3.11 by Application Systems Heidelberg  (also
  5517.      available as Fuji Base 1.0)
  5518.  
  5519.  
  5520. D.3  Generated files
  5521. ====================
  5522.  
  5523. A short description of the files, UDO saves next to its log files:
  5524.  
  5525.  .1:       Nroff
  5526.  .c:       C source code
  5527.  .cmd:     command file for the Pure C help compiler
  5528.  .txt:     ASCII
  5529.  .hpj:     project file for the Microsoft Help Compiler HC.EXE
  5530.  .htm(l):  HTML
  5531.  .lyx:     LyX
  5532.  .man:     Manualpage
  5533.  .pas:     Pascal source code
  5534.  .rtf:     RTF or WinHelp source code or QuickView source code
  5535.  .scr:     Pure C Help source code
  5536.  .sgm(l):  Linuxdoc-SGML
  5537.  .stg:     ST-Guide source code
  5538.  .txt:     Turbo-Vision-Help source code
  5539.  .tex:     LaTeX
  5540.  .texinfo: Texinfo
  5541.  
  5542. Files with the suffix .ul? contain the error messages and warnings UDO
  5543. prints while converting the source file.
  5544.  
  5545. Files with the suffix .uh? contain the  syllabification  patterns  UDO
  5546. prints for ASCII, ST-Guide and Pure C Help.
  5547.  
  5548. Files with the suffix .ut? contain the "include tree".
  5549.  
  5550. The following  suffixes  appear  if  UDO  saves  a file that has to be
  5551. converted with another software to get the final result:
  5552.  
  5553.  .err: log file of the Microsoft Help Compiler (HC.EXE)
  5554.  
  5555.  .h:   C header file for Turbo Vision (TVHC.EXE)
  5556.  
  5557.  .hlp: Windows Help file (HC.EXE), Turbo Vision Help file  (TVHC.EXE),
  5558.        Pure C Help file (HC.PRG)
  5559.  
  5560.  .hyp: ST-Guide hypertext (HCP.TTP)
  5561.  
  5562.  .ref: ST-Guide reference file (HCP.TTP)
  5563.  
  5564.  
  5565.  
  5566. ======================================================================
  5567. Appendix E
  5568.  
  5569. History
  5570. ======================================================================
  5571.  
  5572. In this  chapter  you  will find a short summary of all the changes in
  5573. the past.
  5574.  
  5575.  
  5576. E.1  Last minute changes
  5577. ========================
  5578.  
  5579. In this section you will find all the changes that aren't discussed in
  5580. the other parts of this documentation yet.
  5581.  
  5582.   1. Destination format "NROFF"
  5583.  
  5584.      I don't know if UDO really saves NROFF or if it's TROFF or GROFF.
  5585.      But you can already use it  to  make  simple  manpages  for  Unix
  5586.      systems.
  5587.  
  5588.   2. Destination formats "C source code" and "Pascal source code"
  5589.  
  5590.      Using these  formats  it's  possible to edit a C or Pascal source
  5591.      code and its documentation in one file.
  5592.  
  5593.      UDO will print "normal" text using the comment characters of C or
  5594.      Pascal. The source code will be printed without conversion.
  5595.  
  5596.   3. The sourcecode environment
  5597.  
  5598.      Lines that  are  part of a sourcecode environment will be printed
  5599.      for C and Pascal  without  any  conversion.  If  you  convert  to
  5600.      "normal"  formats,  UDO  prints  the lines as they were part of a
  5601.      verbatim environment that is used inside a quote environment.
  5602.  
  5603. A small example of a C source code written with UDO:
  5604.  
  5605.      !program Hello, world!
  5606.      !author Dirk Hagedorn
  5607.      
  5608.      !begin_document
  5609.      
  5610.      !node Hello, World
  5611.      This program is just for demonstrating
  5612.      the sourcecode environment.
  5613.      
  5614.      !begin_sourcecode
  5615.      #include <stdio.h>
  5616.      
  5617.      int main ( void )
  5618.      {
  5619.              printf("Hello, world!\n");
  5620.      
  5621.              return 0;
  5622.      }
  5623.      !end_sourcecode
  5624.      
  5625.      !end_document
  5626.  
  5627.  
  5628. E.2  Release 6
  5629. ==============
  5630.  
  5631. UDO6 was released on January 3rd, 1997.
  5632.  
  5633. You will find here a very compressed list of the major changes of  the
  5634. last  eight  months.  UDO  supports  now  more destination formats, it
  5635. supports new features and there were fixed a  lot  of  bugs.  In  some
  5636. cases it was impossible not to change the syntax of some commands.
  5637.  
  5638.  New destination formats:
  5639.  
  5640.         ⁿ Apple QuickView
  5641.         ⁿ HP-HelpTag-SGML (rudimentכr)
  5642.         ⁿ LyX
  5643.         ⁿ C and Pascal source code (see "Last minute changes")
  5644.         ⁿ NROFF (see "Last minute changes")
  5645.  
  5646.  New commands:
  5647.  
  5648.         ⁿ !autoref_items [off|on]:  Shall UDO insert links in items of
  5649.           descriptions and lists?
  5650.         ⁿ !code_mac, !code_hp8,  !code_iso,  !code_dos and  !code_tos:
  5651.           UDO  understands  now  the character sets of other operating
  5652.           systems.
  5653.         ⁿ !country: Additional title page information.
  5654.         ⁿ !html_backpage: For a back-link on the HTML title page.
  5655.         ⁿ !html_keywords: For HTML meta information.
  5656.         ⁿ !html_img_suffix: To enable you to use JPEG images etc.
  5657.         ⁿ !html_nodesize:  For  changing  the  font   size   of   HTML
  5658.           headlines.
  5659.         ⁿ !ifos und !ifnos: For checking the operatin system.
  5660.         ⁿ !ignore_headline,  !ignore_bottomline:  For  suppressing the
  5661.           headline or the bottomline of a specific node.
  5662.         ⁿ !ignore_subtoc und Verwandte: For suppressing the  sub-table
  5663.           of contents inside a specific node.
  5664.         ⁿ !ignore_links: For suppressing links to a specific node.
  5665.         ⁿ !image*: For printing image captions without "Figure #:".
  5666.         ⁿ !image_counter: For changing the image counter.
  5667.         ⁿ !no_index: For suppressing index command conversion.
  5668.         ⁿ !no_toc_subnodes,                       !no_toc_subsubnodes,
  5669.           !no_toc_subsubsubnodes: For making  the  table  of  contents
  5670.           smaller.
  5671.         ⁿ !no_preamble: Useful if you want to write your own preamble.
  5672.         ⁿ !parwidth:  For changing the paragraph width of the destina-
  5673.           tion file.
  5674.         ⁿ !rtf_charwidth:  For  changing  the  value  UDO   uses   for
  5675.           calulating indents and cell widths.
  5676.         ⁿ !set,  !unset,  !ifset,  !ifnset:  For  setting and checking
  5677.           symbols.
  5678.         ⁿ !sort_hyphen_file: Shall UDO sort the hyphen file and delete
  5679.           duplicates?
  5680.         ⁿ !subsubsubnode und Verwandte: A fourth layer.
  5681.         ⁿ !table_counter: For changing the table counter.
  5682.         ⁿ !table_caption*:  For printing table captions without "Table
  5683.           #:".
  5684.         ⁿ !tabwidth: For setting the tabulator width for verbatim  en-
  5685.           vironments.
  5686.         ⁿ !use_justification: Shall UDO generate justification?
  5687.         ⁿ !use_nodes_inside_index,            !use_alias_inside_index,
  5688.           !use_label_inside_index: For appending  nodes,  aliases  and
  5689.           labels to the index.
  5690.         ⁿ !use_output_buffer:  Shall  UDO  use  a  buffer  to make the
  5691.           referencation more perfectly for HTML and Windows Help?
  5692.         ⁿ !use_short_envs: For  printing  always  compressed  environ-
  5693.           ments.
  5694.         ⁿ !verbatimsize:  For changing the font size of verbatim envi-
  5695.           ronments.
  5696.         ⁿ !win_background: For  changing  the  background  colour  for
  5697.           Windows Help.
  5698.         ⁿ !win_high_compression,  !win_medium_compression: For setting
  5699.           the compression rate for Windows Help.
  5700.         ⁿ !win_inline_bitmaps: Shall UDO use special RTF commands  for
  5701.           using inline bitmaps?
  5702.         ⁿ !win_charwidth:   For   changing  the  value  UDO  uses  for
  5703.           calulating indents and cell widths.
  5704.  
  5705.  News:
  5706.  
  5707.         ⁿ You can use four layers now for structuring your text.
  5708.         ⁿ Justification
  5709.         ⁿ Macros and definitions can contain parameters. Thus, you can
  5710.           write your own commands in most cases.
  5711.         ⁿ blist environment, ilist environment and tlist environment
  5712.         ⁿ right justified text (flushright environment)
  5713.         ⁿ left  justfied  text (flushleft environment) for suppressing
  5714.           the justification
  5715.         ⁿ You can use up to four E-Mail addresses on  the  title  page
  5716.           now.
  5717.         ⁿ UDO   supports   Italian   (!language   italian),   Spanisch
  5718.           (!language spanish) and Swedish (!language swedish) now.
  5719.         ⁿ UDO can sort the hyphen file and delete duplicates.
  5720.         ⁿ !no_umlaute converts now all international  characters,  not
  5721.           only the German umlauts.
  5722.         ⁿ The source code was optimized. Although UDO supports lots of
  5723.           new commands this version of UDO runs faster  than  the  old
  5724.           one.
  5725.  
  5726.  Changes:
  5727.  
  5728.         ⁿ The RTF output was programmed completely new. You can import
  5729.           UDO's RTF files without problems in WinWord.
  5730.         ⁿ UDO saves a preamble for LaTeX 2.09 and LaTeX2e on  its  own
  5731.           (you can switch it off, if you want).
  5732.         ⁿ UDO  allows  you to use many more nodes, table rows, hyphens
  5733.           etc.
  5734.         ⁿ UDO checks the source files more pedantically.
  5735.         ⁿ Images are positioned like the  outer  text.  To  center  an
  5736.           image you have to use the !image command inside a center en-
  5737.           vironment. Thus, you can  print  left  and  right  justified
  5738.           images, too.
  5739.         ⁿ The suffix for ASCII files is now .txt.
  5740.         ⁿ UDO  doesn't  break  line  between  \verb when converting to
  5741.           LaTeX.
  5742.         ⁿ Graphic characters of the  IBM  PC  character  set  will  be
  5743.           replaced by `+', `-' and `|' for Windows Help.
  5744.  
  5745.  Syntax changes:
  5746.  
  5747.         ⁿ !no_verbatim_umlaute replaces           the           switch
  5748.           !verbatim_no_umlaute
  5749.         ⁿ The switch !list_parsep doesn't exist anymore. You can print
  5750.           "compressed" environment easier with !short now.
  5751.         ⁿ The  language of the destination file has to be set with the
  5752.           !language command   now.   !language english replaces    the
  5753.           command !endlish.
  5754.         ⁿ You  can  pass  three  index entries with one !index command
  5755.           now.
  5756.         ⁿ !win_html_look doesn't exist anymore.
  5757.         ⁿ Shdowed, hollow, outlined and framed  text  isn't  supported
  5758.           anymore.   But   you  can  define  your  own  commands  with
  5759.           definitions if you need these text styles.
  5760.  
  5761.  
  5762. E.3  Release 5
  5763. ==============
  5764.  
  5765. A very short description of the major changes I added to this  release
  5766. for the last five months is listed here. It wasn't possible to prevent
  5767. a change of the syntax of some commands.
  5768.  
  5769.  New destination formats:
  5770.         ⁿ Linuxdoc-SGML
  5771.         ⁿ Turbo Vision Help
  5772.         ⁿ Texinfo
  5773.  New commands:
  5774.         ⁿ !alias
  5775.         ⁿ !begin_raw, !end_raw
  5776.           inside the raw environment you can  enter  special  commands
  5777.           for a destination format
  5778.         ⁿ !begin_table, !end_table
  5779.           setting tables like in LaTeX!
  5780.         ⁿ !chapterimage
  5781.           an image can be used for the title of a chapter
  5782.         ⁿ !define
  5783.         ⁿ !french
  5784.           for French expressions
  5785.         ⁿ !heading, !subheading, !subsubheading
  5786.           for displaying headlines
  5787.         ⁿ !hline
  5788.           for displaying horizontal lines
  5789.         ⁿ !htmlname
  5790.           to set the filename of a chapter
  5791.         ⁿ !html_merge_nodes,                     !html_merge_subnodes,
  5792.           !html_merge_subsubnodes
  5793.           for merging chapters when converting to HTML
  5794.         ⁿ (!ilink ...)
  5795.           for displaying images with links inside  the  text,  Windows
  5796.           Help and HTML only
  5797.         ⁿ (!img ...)
  5798.           for displaying images inside the text, Windows Help and HTML
  5799.           only
  5800.         ⁿ !index
  5801.           for setting an index entry
  5802.         ⁿ !list_parsep
  5803.           for switching the use of empty lines between items of an en-
  5804.           vironment
  5805.         ⁿ !ifdest, !else, !endif
  5806.           for special passages
  5807.         ⁿ !iflang, !else, !endif
  5808.           for special passages with different languages
  5809.         ⁿ !node*,   !subnode*,   !subsubnode*,   !pnode*,  !psubnode*,
  5810.           !psubsubnode*
  5811.           for chapters that don't appear inside a table of contents
  5812.         ⁿ !rinclude
  5813.           for including special commands
  5814.         ⁿ !use_about_udo
  5815.         ⁿ !use_chapter_images
  5816.           for displaying images instead of chapter titles
  5817.         ⁿ !use_style_book
  5818.         ⁿ !win_html_look
  5819.           for using grey inside a Windows Help file
  5820.  Changes:
  5821.         ⁿ You can display tables very easily. You can  define  how  to
  5822.           justify  columns  and  where to draw horizontal and vertical
  5823.           lines.
  5824.         ⁿ The layout of the  environments  was  programmed  completely
  5825.           new.  Now you can use up to six environments inside another,
  5826.           the xlist environment, too! UDO generates a  correct  output
  5827.           for Windows Help and RTF.
  5828.         ⁿ The  semiautomatic syllabification was programmed completely
  5829.           new.
  5830.         ⁿ UDO now references only complete words.
  5831.         ⁿ You can use 1024 chapters and 1024 labels now.
  5832.         ⁿ You can use up to 200 links inside a paragraph. Due to a bug
  5833.           you  could  only  use 16 links inside a complete document in
  5834.           release 4.
  5835.         ⁿ Manualpages are layouted completely new.
  5836.         ⁿ Paintbrush PCX images are supported for emTeX.
  5837.         ⁿ The output of Windows Help was updated in many cases!
  5838.         ⁿ The Atari versions were compiled with MiNT libs PL46.
  5839.  Syntactical changes:
  5840.         ⁿ The special environments  that  were  built  with  !begin_*,
  5841.           !else_* and  !end_* have  to  made  with  the  more flexible
  5842.           commands !ifdest, !else and !endif.
  5843.           Instead of...
  5844.                !begin_asc
  5845.                [...]
  5846.                !else_asc
  5847.                [...]
  5848.                !end_asc
  5849.           ... you now have to use this construction:
  5850.                !ifdest [asc]
  5851.                [...]
  5852.                !else
  5853.                [...]
  5854.                !endif
  5855.  Bug fixes:
  5856.      Innumerous. ;-)
  5857.  
  5858.  
  5859. E.4  Release 4
  5860. ==============
  5861.  
  5862. This was the first English version with an English documentation!
  5863.  
  5864.  
  5865. E.5  Release 3
  5866. ==============
  5867.  
  5868. I think that nobody is interested in those things that changed a  year
  5869. ago.
  5870.  
  5871.  
  5872.  
  5873. ======================================================================
  5874. Appendix F
  5875.  
  5876. Command index
  5877. ======================================================================
  5878.  
  5879. In this chapter you will find a short description of every UDO command
  5880. in alphabetical order. The command description shows you  the  meaning
  5881. of the descriptions.
  5882.  
  5883.  
  5884. Command description
  5885. ===================
  5886.  
  5887.  Type & position:
  5888.      The  type  of  the command and the position where it's allowed to
  5889.      use it.
  5890.  
  5891.      A command tells UDO do something especially, a switch  sets  some
  5892.      internal  information  for  UDO  and a placeholder will be simply
  5893.      replaced by a different text fragment.
  5894.  
  5895.      "Preamble" means that you are only allowed to use this command in
  5896.      the  preamble of your source file (before !begin_document). "Main
  5897.      part"  means  that  you  are  only  allowed  to  use  it   behind
  5898.      !begin_document.  "Preamble  &  main part" means that you can use
  5899.      this command wherever you want.
  5900.  
  5901.  Syntax:
  5902.      Here you can see how to use the command.
  5903.  
  5904.       <text>         replaces text
  5905.  
  5906.       <file>         replaces a file name
  5907.  
  5908.       <value>        replaces a number
  5909.  
  5910.       <char>         replaces a single character
  5911.  
  5912.       <abbreviations> replaces the  abbreviation  of  the  destination
  5913.                      formats (aqv = Apple QuickView, asc = ASCII, htag
  5914.                      = HP-Helptag-SGML, html = HTML, info  =  Texinfo,
  5915.                      ldoc   =   Linuxdoc-SGML,   lyx   =  LyX,  man  =
  5916.                      Manualpage, pch = Pure-C-Help, rtf = RTF,  stg  =
  5917.                      ST-Guide,  tex  = LaTeX, tvh = Turbo-Vision-Help,
  5918.                      win = WinHelp)
  5919.  
  5920.       <language>     replaces  the  abbreviation  of  the  destination
  5921.                      language (english  =  English,  french  = French,
  5922.                      german = German, italian  =  Italian,  spanish  =
  5923.                      Spanish, swedish = Swedish)
  5924.  
  5925.       <systems>      replaces  one  or  more operating systems (beos =
  5926.                      BeOS, dos = DOS, hpux =  HP-UX,  linux  =  Linux,
  5927.                      macos  =  MacOS,  nextstep  =  NeXTStep,  sinix =
  5928.                      SINIX, sunos = SunOS, tos = TOS)
  5929.  
  5930.  Example:
  5931.      Here you can see a small example.
  5932.  
  5933.  See also:
  5934.      Related commands and topic are listed here.
  5935.  
  5936.  
  5937. F.1  A...
  5938. =========
  5939.  
  5940.  
  5941. F.1.1  !=aqv
  5942. ------------
  5943.  
  5944.  Type & position: command, preamble & main part
  5945.  
  5946.  Syntax:          !=aqv <text>
  5947.  
  5948.  Description:     "<text>" will only be printed if  you  don't convert
  5949.                   into   Apple   QuickView.   "<text>"   will  be  not
  5950.                   converted!
  5951.  
  5952.  See:             !aqv, !ifdest, raw environment
  5953.  
  5954.  
  5955. F.1.2  !=asc
  5956. ------------
  5957.  
  5958.  Type & position: command, preamble & main part
  5959.  
  5960.  Syntax:          !=asc <text>
  5961.  
  5962.  Description:     "<text>" will only be printed if  you  don't convert
  5963.                   into ASCII. "<text>" will be not converted!
  5964.  
  5965.  See:             !asc, !ifdest, raw environment
  5966.  
  5967.  
  5968. F.1.3  !alias
  5969. -------------
  5970.  
  5971.  Type & position: command, main part
  5972.  
  5973.  Syntax:          !alias <text>
  5974.  
  5975.  Description:     "<text>"  is  used as a secondary name of a chapter.
  5976.                   UDO references an alias like a label or  node  name.
  5977.                   You  can use !alias inside a chapter more than once.
  5978.                   But you should use <text> only once.
  5979.  
  5980.  See:             !node,   !subnode,   !subsubnode,    !subsubsubnode,
  5981.                   !label, Links, Labels
  5982.  
  5983.  
  5984. F.1.4  !aqv
  5985. -----------
  5986.  
  5987.  Type & position: command, preamble & main part
  5988.  
  5989.  Syntax:          !aqv <text>
  5990.  
  5991.  Description:     "<text>"  will  only  be printed if you convert into
  5992.                   Apple QuickView. "<text>" will be not converted!
  5993.  
  5994.  See:             !=aqv, !ifdest, raw environment
  5995.  
  5996.  
  5997. F.1.5  !asc
  5998. -----------
  5999.  
  6000.  Type & position: command, preamble & main part
  6001.  
  6002.  Syntax:          !asc <text>
  6003.  
  6004.  Description:     "<text>" will only be printed if  you  convert  into
  6005.                   ASCII. "<text>" will be not converted!
  6006.  
  6007.  See:             !=asc, !ifdest, raw environment
  6008.  
  6009.  
  6010. F.1.6  !author
  6011. --------------
  6012.  
  6013.  Type & position: command, preamble
  6014.  
  6015.  Syntax:          !author <text>
  6016.  
  6017.  Description:     "<text>"  will  be used as the name of the author on
  6018.                   the title page and for different other purposes.
  6019.  
  6020.  Example:         !author Dirk Hagedorn
  6021.  
  6022.  See:             !maketitle, !authorimage, Title page
  6023.  
  6024.  
  6025. F.1.7  !authorimage
  6026. -------------------
  6027.  
  6028.  Type & position: command, preamble
  6029.  
  6030.  Syntax:          !authorimage <file>
  6031.  
  6032.  Description:     <file> will be  displayed  above  the  name  of  the
  6033.                   author  on  the title page if the destination format
  6034.                   supports images.
  6035.  
  6036.  Example:         !authorimage dh
  6037.  
  6038.  See:             !maketitle, !author, Title page, Images
  6039.  
  6040.  
  6041. F.1.8  !autoref
  6042. ---------------
  6043.  
  6044.  Type & position: switch, main part
  6045.  
  6046.  Syntax:          !autoref [ on | off ]
  6047.  
  6048.  Description:     Switches on or off automatic  references.  When  UDO
  6049.                   starts  it  will  insert references automatically by
  6050.                   default. For the ST-Guide UDO  prints  @autorefon or
  6051.                   @autorefoff.
  6052.  
  6053.  Example:         !autoref [off]
  6054.  
  6055.  See:             Links
  6056.  
  6057.  
  6058. F.1.9  !autoref_items
  6059. ---------------------
  6060.  
  6061.  Type & position: switch, main part
  6062.  
  6063.  Syntax:          !autoref_items [ on | off ]
  6064.  
  6065.  Description:     With  this  command  you can switch on or off if UDO
  6066.                   shall insert links in items of a  description  envi-
  6067.                   ronment  or  xlist  environment.  When UDO starts it
  6068.                   inserts links by default.
  6069.  
  6070.  Example:         !autoref_items [off]
  6071.  
  6072.  See:             Descriptions, Lists, !item [ ]
  6073.  
  6074.  
  6075. F.1.10  (!alpha)
  6076. ----------------
  6077.  
  6078.  Type & position: placeholder, preamble & main part
  6079.  
  6080.  Syntax:          (!alpha)
  6081.  
  6082.  Description:     This placeholder will be replaced by an alpha.
  6083.  
  6084.  Example:         (!alpha) becomes alpha
  6085.  
  6086.  See:             (!beta), Special characters
  6087.  
  6088.  
  6089. F.2  B...
  6090. =========
  6091.  
  6092.  
  6093. F.2.1  !begin_appendix
  6094. ----------------------
  6095.  
  6096.  Type & position: command, main part
  6097.  
  6098.  Syntax:          !begin_appendix
  6099.  
  6100.  Description:     Starts the appendix. Chapters  are  enumerated  with
  6101.                   letters.  UDO  supports only one appendix per source
  6102.                   file!
  6103.  
  6104.  See:             !end_appendix, Appendix
  6105.  
  6106.  
  6107. F.2.2  !begin_blist
  6108. -------------------
  6109.  
  6110.  Type & position: command, main part
  6111.  
  6112.  Syntax:          !begin_blist [<text>]
  6113.  
  6114.  Description:     Starts a new list. The length  of  "<text>"  defines
  6115.                   the  indent  of  the  list. This environment must be
  6116.                   finished with !end_blist. You can use this  environ-
  6117.                   ment  inside  other  environments.  The text you set
  6118.                   with !item [ ] will be displayed with a bold font.
  6119.  
  6120.  See:             !end_blist, !item [ ],  !begin_ilist,  !begin_tlist,
  6121.                   !begin_xlist, Lists
  6122.  
  6123.  
  6124. F.2.3  !begin_center
  6125. --------------------
  6126.  
  6127.  Type & position: command, main part
  6128.  
  6129.  Syntax:          !begin_center
  6130.  
  6131.  Description:     This  command opens a (new) center environment. Text
  6132.                   that is part of a center environment will be printed
  6133.                   centred  until  the !end_center command appears. UDO
  6134.                   layouts the text of a center environment so you will
  6135.                   may  be  be  forced to insert manual linebreaks with
  6136.                   (!nl).
  6137.  
  6138.  See:             !end_center, (!nl)
  6139.  
  6140.  
  6141. F.2.4  !begin_description
  6142. -------------------------
  6143.  
  6144.  Type & position: command, main part
  6145.  
  6146.  Syntax:          !begin_description
  6147.  
  6148.  Description:     Starts a new description environment that has to  be
  6149.                   finished  with  !end_description.  You  can  use the
  6150.                   description environment inside  other  (description)
  6151.                   environments.  Text that stands between the brackets
  6152.                   of !item [ ] will be printed with bold text.
  6153.  
  6154.  See:             !end_description, !item [ ], Descriptions, !short
  6155.  
  6156.  
  6157. F.2.5  !begin_document
  6158. ----------------------
  6159.  
  6160.  Type & position: command, main part
  6161.  
  6162.  Syntax:          !begin_document
  6163.  
  6164.  Description:     This command must be part of every source  file.  It
  6165.                   divides the preamble from the main part.
  6166.  
  6167.  See:             !end_document
  6168.  
  6169.  
  6170. F.2.6  !begin_enumerate
  6171. -----------------------
  6172.  
  6173.  Type & position: command, main part
  6174.  
  6175.  Syntax:          !begin_enumerate
  6176.  
  6177.  Description:     Starts  a  new  enumerate environment that has to be
  6178.                   finished  with  !end_enumerate.  You  can  use   the
  6179.                   enumerate environment inside other (enumerate) envi-
  6180.                   ronments. The items of an enumerate environment will
  6181.                   be marked with alphanumerical characters.
  6182.  
  6183.  See:             !end_enumerate, !item, Enumerations, !short
  6184.  
  6185.  
  6186. F.2.7  !begin_flushleft
  6187. -----------------------
  6188.  
  6189.  Type & position: command, main part
  6190.  
  6191.  Syntax:          !begin_flushleft
  6192.  
  6193.  Description:     Lines  that  are  part  of flushleft environment are
  6194.                   printed left justified without justification.
  6195.  
  6196.  See:             !end_flushleft
  6197.  
  6198.  
  6199. F.2.8  !begin_flushright
  6200. ------------------------
  6201.  
  6202.  Type & position: command, main part
  6203.  
  6204.  Syntax:          !begin_flushright
  6205.  
  6206.  Description:     Lines that are part of  flushright  environment  are
  6207.                   printed right justified without justification.
  6208.  
  6209.  See:             !end_flushright
  6210.  
  6211.  
  6212. F.2.9  !begin_ilist
  6213. -------------------
  6214.  
  6215.  Type & position: command, main part
  6216.  
  6217.  Syntax:          !begin_ilist [<text>]
  6218.  
  6219.  Description:     Starts  a  new  list. The length of "<text>" defines
  6220.                   the indent of the list.  This  environment  must  be
  6221.                   finished  with !end_ilist. You can use this environ-
  6222.                   ment inside other (iltalic list)  environments.  The
  6223.                   text  you  set with !item [ ] will be displayed with
  6224.                   an italic font.
  6225.  
  6226.  See:             !end_ilist, !item [ ],  !begin_blist,  !begin_xlist,
  6227.                   !begin_tlist, Lists
  6228.  
  6229.  
  6230. F.2.10  !begin_itemize
  6231. ----------------------
  6232.  
  6233.  Type & position: command, main part
  6234.  
  6235.  Syntax:          !begin_itemize
  6236.  
  6237.  Description:     Starts  a  new  itemize  environment  that has to be
  6238.                   finished with !end_itemize. You can use the  itemize
  6239.                   environment  inside  other  (itemize)  environments.
  6240.                   Items of the itemize environment will be marked with
  6241.                   bullets, dashes or stars.
  6242.  
  6243.  See:             !end_itemize, !item, Itemizations, !short
  6244.  
  6245.  
  6246. F.2.11  !begin_quote
  6247. --------------------
  6248.  
  6249.  Type & position: command, main part
  6250.  
  6251.  Syntax:          !begin_quote
  6252.  
  6253.  Description:     This command starts a new quote environment. Text is
  6254.                   printend indented until  UDO  reads  the  !end_quote
  6255.                   command.
  6256.  
  6257.  See:             !end_quote, Indented paragraphs
  6258.  
  6259.  
  6260. F.2.12  !begin_raw
  6261. ------------------
  6262.  
  6263.  Type & position: command, preamble & main part
  6264.  
  6265.  Syntax:          !begin_raw
  6266.  
  6267.  Description:     Starts  a  raw  environment  that has to be finished
  6268.                   with !end_raw. Each  line  inside  this  environment
  6269.                   will be output directly without any conversion. Thus
  6270.                   this environment can  be  used  to  insert  specific
  6271.                   commands for the destionation format.
  6272.  
  6273.  See:             !end_raw, raw environment, !rinclude, !ifdest
  6274.  
  6275.  
  6276. F.2.13  !begin_sourcecode
  6277. -------------------------
  6278.  
  6279.  Type & position: command, main part
  6280.  
  6281.  Syntax:          !begin_sourcecode
  6282.  
  6283.  Description:     With  this  command you can start a sourcecode envi-
  6284.                   ronment.  It   has   to   be   finished   with   the
  6285.                   !end_sourcecode command.  Lines  that  are part of a
  6286.                   sourcecode  environment  will  be  printed   without
  6287.                   conversion  for  the  sourcecode  formats.  For  the
  6288.                   "normal" formats the text of the sourcecode environ-
  6289.                   ment  will  be printed like text of a verbatim envi-
  6290.                   ronment that is used inside a quote environment.
  6291.  
  6292.  See:             !end_sourcecode
  6293.  
  6294.  
  6295. F.2.14  !begin_table
  6296. --------------------
  6297.  
  6298.  Type & position: command, main part
  6299.  
  6300.  Syntax:          !begin_table [<format>] {!hline}
  6301.  
  6302.  Description:     With this command a table is started.  For  <format>
  6303.                   you  enter  the justification of the columns of this
  6304.                   table and the position of vertical  lines.  If  this
  6305.                   command  is  followed  by  `!hline' the table starts
  6306.                   with a horizontal line. The  example  shows  how  to
  6307.                   make  a  table  with  three  columns  where the left
  6308.                   column is left justified, the second is centered and
  6309.                   the  last  columns  is  right  justified.  The table
  6310.                   begins with a horizontal line an it has one vertical
  6311.                   line on the left
  6312.  
  6313.  Example:         !begin_table [|lcr|] !hline
  6314.  
  6315.  See:             !hline, !end_table, Tables
  6316.  
  6317.  
  6318. F.2.15  !begin_tlist
  6319. --------------------
  6320.  
  6321.  Type & position: command, main part
  6322.  
  6323.  Syntax:          !begin_tlist [<text>]
  6324.  
  6325.  Description:     Starts  a  new  list. The length of "<text>" defines
  6326.                   the indent of the list.  This  environment  must  be
  6327.                   finished  with !end_tlist. You can use this environ-
  6328.                   ment inside other environments.  The  text  you  set
  6329.                   with  !item [ ] will  be displayed with a monospaced
  6330.                   font.
  6331.  
  6332.  See:             !end_tlist, !item [ ],  !begin_blist,  !begin_ilist,
  6333.                   !begin_xlist, Lists
  6334.  
  6335.  
  6336. F.2.16  !begin_verbatim
  6337. -----------------------
  6338.  
  6339.  Type & position: command, main part
  6340.  
  6341.  Syntax:          !begin_verbatim
  6342.  
  6343.  Description:     Starts   a  verbatim  environment  that  has  to  be
  6344.                   finished with !end_verbatim. Text that is part of  a
  6345.                   verbatim environment is printed out as given using a
  6346.                   monospaced font.
  6347.  
  6348.  See:             !end_verbatim, Preformatted text, !vinclude
  6349.  
  6350.  
  6351. F.2.17  !begin_xlist
  6352. --------------------
  6353.  
  6354.  Type & position: command, main part
  6355.  
  6356.  Syntax:          !begin_xlist [<text>]
  6357.  
  6358.  Description:     Starts a new list. The length  of  "<text>"  defines
  6359.                   the  indent  of  the  list. This environment must be
  6360.                   finished with !end_xlist. You can use this  environ-
  6361.                   ment  inside  other  environments.  The text you set
  6362.                   with !item [ ] will be  displayed  with  the  normal
  6363.                   font.
  6364.  
  6365.  See:             !end_xlist,  !item [ ],  !begin_blist, !begin_ilist,
  6366.                   !begin_tlist, Lists
  6367.  
  6368.  
  6369. F.2.18  !bigskip
  6370. ----------------
  6371.  
  6372.  Type & position: command, main part
  6373.  
  6374.  Syntax:          !bigskip
  6375.  
  6376.  Description:     This command will be simplay replaced by  "\bigskip"
  6377.                   when  converted to LaTeX. Otherwise three additional
  6378.                   empty lines will be generated.
  6379.  
  6380.  See:             !smallskip, !medskip
  6381.  
  6382.  
  6383. F.2.19  !break
  6384. --------------
  6385.  
  6386.  Type & position: command, main part
  6387.  
  6388.  Syntax:          !break
  6389.  
  6390.  Description:     You can use this command inside the source  file  to
  6391.                   stop  the conversion right at the line where you use
  6392.                   this   command.    UDO    calls    !end_appendix and
  6393.                   !end_document itself if necessary.
  6394.  
  6395.  
  6396. F.2.20  (!B)...(!b)
  6397. -------------------
  6398.  
  6399.  Type & position: placeholder, preamble & main part
  6400.  
  6401.  Syntax:          (!B)<text>(!b)
  6402.  
  6403.  Description:     "<text>" will be displayed in bold text if possible.
  6404.  
  6405.  Example:         (!B)bold(!b)
  6406.  
  6407.  See:             Emphasizing text
  6408.  
  6409.  
  6410. F.2.21  (!beta)
  6411. ---------------
  6412.  
  6413.  Type & position: placeholder, preamble & main part
  6414.  
  6415.  Syntax:          (!beta)
  6416.  
  6417.  Description:     This placeholder will be replaced by beta.
  6418.  
  6419.  Example:         (!beta) becomes beta
  6420.  
  6421.  See:             (!alpha), Special characters
  6422.  
  6423.  
  6424. F.3  C...
  6425. =========
  6426.  
  6427.  
  6428. F.3.1  !chapterimage
  6429. --------------------
  6430.  
  6431.  Type & position: command, main part
  6432.  
  6433.  Syntax:          !chapterimage <file>
  6434.  
  6435.  Description:     Converting  to  Windows  Help,  HTML or ST-Guide the
  6436.                   image called `<file>' is displayed  instead  of  the
  6437.                   chapter  title if !use_chapter_images is used inside
  6438.                   the preamble.
  6439.  
  6440.  Example:         !chapterimage udo
  6441.  
  6442.  See:             Images, !use_chapter_images
  6443.  
  6444.  
  6445. F.3.2  !code_dos
  6446. ----------------
  6447.  
  6448.  Type & position: switch, preamble & main part
  6449.  
  6450.  Syntax:          !code_dos
  6451.  
  6452.  Description:     UDO expects files written in  the  IBM-PC  character
  6453.                   set  after this command. You can switch back to your
  6454.                   system charset with some other commands (see below).
  6455.  
  6456.  See:             !code_iso, !code_mac, !code_hp8, !code_tos,  Special
  6457.                   characters
  6458.  
  6459.  
  6460. F.3.3  !code_hp8
  6461. ----------------
  6462.  
  6463.  Type & position: switch, preamble & main part
  6464.  
  6465.  Syntax:          !code_hp8
  6466.  
  6467.  Description:     UDO  expects files written in the HP Roman 8 charac-
  6468.                   terset after this command. You can  switch  back  to
  6469.                   your  system  charset  with some other commands (see
  6470.                   below).
  6471.  
  6472.  See:             !code_dos, !code_iso, !code_mac, !code_tos,  Special
  6473.                   characters
  6474.  
  6475.  
  6476. F.3.4  !code_iso
  6477. ----------------
  6478.  
  6479.  Type & position: switch, preamble & main part
  6480.  
  6481.  Syntax:          !code_iso
  6482.  
  6483.  Description:     UDO expects files written in the ISO characterset or
  6484.                   Windows ANSI characterset after  this  command.  You
  6485.                   can  switch  back  to  your system charset with some
  6486.                   other commands (see below).
  6487.  
  6488.  See:             !code_dos, !code_mac, !code_hp8, !code_tos,  Special
  6489.                   characters
  6490.  
  6491.  
  6492. F.3.5  !code_mac
  6493. ----------------
  6494.  
  6495.  Type & position: switch, preamble & main part
  6496.  
  6497.  Syntax:          !code_mac
  6498.  
  6499.  Description:     UDO expects files written in the Macintosh character
  6500.                   set behind this command. You can switch back to your
  6501.                   system charset with some other commands (see below).
  6502.  
  6503.  See:             !code_dos,  !code_iso, !code_hp8, !code_tos, Special
  6504.                   characters
  6505.  
  6506.  
  6507. F.3.6  !code_tos
  6508. ----------------
  6509.  
  6510.  Type & position: switch, preamble & main part
  6511.  
  6512.  Syntax:          !code_tos
  6513.  
  6514.  Description:     UDO expects files written in the  Atari  ST  charac-
  6515.                   terset  behind  this command. You can switch back to
  6516.                   your system charset with some  other  commands  (see
  6517.                   below).
  6518.  
  6519.  See:             !code_dos,  !code_iso, !code_mac, !code_hp8, Special
  6520.                   characters
  6521.  
  6522.  
  6523. F.3.7  !country
  6524. ---------------
  6525.  
  6526.  Type & position: command, preamble
  6527.  
  6528.  Syntax:          !country <text>
  6529.  
  6530.  Description:     "<text>" will be displayed below  the  town  of  the
  6531.                   author on the title page to show in which country he
  6532.                   lives.
  6533.  
  6534.  Example:         !country Germany
  6535.  
  6536.  See:             !maketitle, Title page
  6537.  
  6538.  
  6539. F.3.8  (!copyright)
  6540. -------------------
  6541.  
  6542.  Type & position: special character(s), preamble & main part
  6543.  
  6544.  Syntax:          (!copyright)
  6545.  
  6546.  Description:     This placeholder  will  be  replaced  by  a  special
  6547.                   copyright  symbol if the destination format supports
  6548.                   them.  If  it  doesn't   UDO   will   replace   this
  6549.                   placeholder by "(c)".
  6550.  
  6551.  Example:         (!copyright) is converted to (c)
  6552.  
  6553.  
  6554. F.4  D...
  6555. =========
  6556.  
  6557.  
  6558. F.4.1  !date
  6559. ------------
  6560.  
  6561.  Type & position: command, preamble
  6562.  
  6563.  Syntax:          !date <text>
  6564.  
  6565.  Description:     "<text>"  will  be displayed on the title page below
  6566.                   the contents of !version. The example shows  how  to
  6567.                   use the current system time for the title page.
  6568.  
  6569.  Example:         !date (!today)
  6570.  
  6571.  See:             !maketitle, (!today), (!short_today), Title page
  6572.  
  6573.  
  6574. F.4.2  !define
  6575. --------------
  6576.  
  6577.  Type & position: command, preamble
  6578.  
  6579.  Syntax:          !define <word> <text>
  6580.  
  6581.  Description:     Sets  a  (new)  definition. When converting UDO will
  6582.                   replace  every  "(!<word>)"  by   "<text>"   without
  6583.                   converting  special  chars.  When  using  the  lower
  6584.                   exmaple every "(!H1)" will be replaced  by  "</H1>".
  6585.                   The  difference  to  a  macro:  no  umlauts or other
  6586.                   special chars will  be  converted.  Definitions  can
  6587.                   contain  parameters.  Read the chapter "Definitions"
  6588.                   to  get  to  know  how  to  use   definitions   with
  6589.                   parameters.
  6590.  
  6591.  Example:         !define H1 </H1>
  6592.  
  6593.  See:             Definitions
  6594.  
  6595.  
  6596. F.5  E...
  6597. =========
  6598.  
  6599.  
  6600. F.5.1  !else
  6601. ------------
  6602.  
  6603.  Type & position: command, preamble & main part
  6604.  
  6605.  Syntax:          !else
  6606.  
  6607.  Description:     The   following   lines   are  converted  until  the
  6608.                   appearance of !endif, if  the  abbreviation  of  the
  6609.                   current  destination  format  wasn't  used  with the
  6610.                   previous !ifdest or !iflang command.
  6611.  
  6612.  See:             !ifdest, !iflang, !endif, Query commands
  6613.  
  6614.  
  6615. F.5.2  !email
  6616. -------------
  6617.  
  6618.  Type & position: command, preamble
  6619.  
  6620.  Syntax:          !email <text>
  6621.  
  6622.  Description:     "<text>" will be dsiplayed on  the  titlepage  below
  6623.                   the  name  and  address of the author. !email can be
  6624.                   used up to four times to enable you  to  print  more
  6625.                   than one email address on the title page.
  6626.  
  6627.  Example:         !email Internet: dh@mk2.maus.sauerland.de
  6628.  
  6629.  See:             !maketitle, Title page
  6630.  
  6631.  
  6632. F.5.3  !end_appendix
  6633. --------------------
  6634.  
  6635.  Type & position: command, main part
  6636.  
  6637.  Syntax:          !end_appendix
  6638.  
  6639.  Description:     This  command  finishes  the  appendix. UDO supports
  6640.                   only one appendix, so this  command  should  be  the
  6641.                   precessor of !begin_document.
  6642.  
  6643.  See:             !begin_appendix, Appendix
  6644.  
  6645.  
  6646. F.5.4  !end_blist
  6647. -----------------
  6648.  
  6649.  Type & position: command, main part
  6650.  
  6651.  Syntax:          !end_blist
  6652.  
  6653.  Description:     Finsihes the latest blist ("bold list") environment.
  6654.  
  6655.  See:             !begin_blist, !item [ ], Lists
  6656.  
  6657.  
  6658. F.5.5  !end_center
  6659. ------------------
  6660.  
  6661.  Type & position: command, main part
  6662.  
  6663.  Syntax:          !end_center
  6664.  
  6665.  Description:     This command finishes the latest center environment.
  6666.  
  6667.  See:             !begin_center, center environment
  6668.  
  6669.  
  6670. F.5.6  !end_description
  6671. -----------------------
  6672.  
  6673.  Type & position: command, main part
  6674.  
  6675.  Syntax:          !end_description
  6676.  
  6677.  Description:     This command finishes the latest descripion environ-
  6678.                   ment.
  6679.  
  6680.  See:             !begin_description, !item [ ], description  environ-
  6681.                   ment
  6682.  
  6683.  
  6684. F.5.7  !end_document
  6685. --------------------
  6686.  
  6687.  Type & position: command, main part
  6688.  
  6689.  Syntax:          !end_document
  6690.  
  6691.  Description:     This  command  must be  part of a source file and it
  6692.                   should be the last command. If  you  forget  to  use
  6693.                   this command UDO will print an error message.
  6694.  
  6695.  See:             !begin_document
  6696.  
  6697.  
  6698. F.5.8  !end_enumerate
  6699. ---------------------
  6700.  
  6701.  Type & position: command, main part
  6702.  
  6703.  Syntax:          !end_enumerate
  6704.  
  6705.  Description:     Finishes the latest enumerate environment.
  6706.  
  6707.  See:             !begin_enumerate, !item, enumerate environment
  6708.  
  6709.  
  6710. F.5.9  !end_flushleft
  6711. ---------------------
  6712.  
  6713.  Type & position: command, main part
  6714.  
  6715.  Syntax:          !end_flushleft
  6716.  
  6717.  Description:     This  command finishes the latest flushleft environ-
  6718.                   ment.
  6719.  
  6720.  See:             !begin_flushleft, flushleft environment
  6721.  
  6722.  
  6723. F.5.10  !end_flushright
  6724. -----------------------
  6725.  
  6726.  Type & position: command, main part
  6727.  
  6728.  Syntax:          !end_flushright
  6729.  
  6730.  Description:     This command finishes the latest flushright environ-
  6731.                   ment.
  6732.  
  6733.  See:             !begin_flushright, flushright environment
  6734.  
  6735.  
  6736. F.5.11  !end_ilist
  6737. ------------------
  6738.  
  6739.  Type & position: command, main part
  6740.  
  6741.  Syntax:          !end_ilist
  6742.  
  6743.  Description:     Finishes  the  latest ilist ("italic list") environ-
  6744.                   ment.
  6745.  
  6746.  See:             !begin_ilist, !item [ ], Lists
  6747.  
  6748.  
  6749. F.5.12  !end_itemize
  6750. --------------------
  6751.  
  6752.  Type & position: command, main part
  6753.  
  6754.  Syntax:          !end_itemize
  6755.  
  6756.  Description:     Finishes the latest itemize environment.
  6757.  
  6758.  See:             !begin_itemize, !item, itemize environment
  6759.  
  6760.  
  6761. F.5.13  !end_quote
  6762. ------------------
  6763.  
  6764.  Type & position: command, main part
  6765.  
  6766.  Syntax:          !end_quote
  6767.  
  6768.  Description:     This command finishes the  last  quote  environment.
  6769.                   Text,  that's  part  of  a quote environment will be
  6770.                   displayed indented.
  6771.  
  6772.  See:             !begin_quote, quote environment
  6773.  
  6774.  
  6775. F.5.14  !end_raw
  6776. ----------------
  6777.  
  6778.  Type & position: command, preamble & main part
  6779.  
  6780.  Syntax:          !end_raw
  6781.  
  6782.  Description:     Finishes the raw environment.
  6783.  
  6784.  See:             !begin_raw, raw environment
  6785.  
  6786.  
  6787. F.5.15  !end_sourcecode
  6788. -----------------------
  6789.  
  6790.  Type & position: command, main part
  6791.  
  6792.  Syntax:          !end_sourcecode
  6793.  
  6794.  Description:     This command finishes the sourcecode environment.
  6795.  
  6796.  See:             !begin_sourcecode
  6797.  
  6798.  
  6799. F.5.16  !end_table
  6800. ------------------
  6801.  
  6802.  Type & position: command, main part
  6803.  
  6804.  Syntax:          !end_table
  6805.  
  6806.  Description:     Finishes the table environment and prints the table.
  6807.  
  6808.  See:             Tables, !begin_table
  6809.  
  6810.  
  6811. F.5.17  !end_tlist
  6812. ------------------
  6813.  
  6814.  Type & position: command, main part
  6815.  
  6816.  Syntax:          !end_tlist
  6817.  
  6818.  Description:     Finsihes the latest tlist environment.
  6819.  
  6820.  See:             !begin_tlist, !item [ ], Lists
  6821.  
  6822.  
  6823. F.5.18  !end_verbatim
  6824. ---------------------
  6825.  
  6826.  Type & position: command, main part
  6827.  
  6828.  Syntax:          !end_verbatim
  6829.  
  6830.  Description:     Finishes the verbatim environment.
  6831.  
  6832.  See:             !begin_verbatim, Preformatted text
  6833.  
  6834.  
  6835. F.5.19  !end_xlist
  6836. ------------------
  6837.  
  6838.  Type & position: command, main part
  6839.  
  6840.  Syntax:          !end_xlist
  6841.  
  6842.  Description:     Finsihes the latest xlist environment.
  6843.  
  6844.  See:             !begin_xlist, !item [ ], Lists
  6845.  
  6846.  
  6847. F.5.20  !endif
  6848. --------------
  6849.  
  6850.  Type & position: command, preamble & main part
  6851.  
  6852.  Syntax:          !endif
  6853.  
  6854.  Description:     Finishes a  query  command  that  was  started  with
  6855.                   !ifdest, !iflang, !ifset, !ifos or !if.
  6856.  
  6857.  See:             !ifdest,  !iflang,  !ifset, !ifos, !if, !else, Query
  6858.                   commands
  6859.  
  6860.  
  6861. F.6  F...
  6862. =========
  6863.  
  6864.  
  6865. F.6.1  !fussy
  6866. -------------
  6867.  
  6868.  Type & position: switch, main part
  6869.  
  6870.  Syntax:          !fussy
  6871.  
  6872.  Description:     Switches on  warning  messages  according  to  short
  6873.                   lines.  You  can use this command wherever you want.
  6874.                   The warnings can  be  disabled  with  !sloppy.  When
  6875.                   converting  to LaTeX UDO doesn't convert !fussy into
  6876.                   `\fussy'!
  6877.  
  6878.  See:             !sloppy, Error messages, Syllabification
  6879.  
  6880.  
  6881. F.7  G...
  6882. =========
  6883.  
  6884.  
  6885. F.7.1  (!grin)
  6886. --------------
  6887.  
  6888.  Type & position: placeholder, preamble & main part
  6889.  
  6890.  Syntax:          (!grin)
  6891.  
  6892.  Description:     (!grin) will be  replaced  by  a  grinning  emoticon
  6893.                   displayed in typewriter.
  6894.  
  6895.  Example:         (!grin) becomes ;-)
  6896.  
  6897.  See:             (!laugh)
  6898.  
  6899.  
  6900. F.8  H...
  6901. =========
  6902.  
  6903.  
  6904. F.8.1  !=htag
  6905. -------------
  6906.  
  6907.  Type & position: command, preamble & main part
  6908.  
  6909.  Syntax:          !=htag<text>
  6910.  
  6911.  Description:     "<text>"  will  only be printed if you don't convert
  6912.                   into Helptag. "<text>" will be not converted!
  6913.  
  6914.  See:             !htag, !ifdest, raw environment
  6915.  
  6916.  
  6917. F.8.2  !=html
  6918. -------------
  6919.  
  6920.  Type & position: command, preamble & main part
  6921.  
  6922.  Syntax:          !=html <text>
  6923.  
  6924.  Description:     "<text>" will only be printed if  you  don't convert
  6925.                   into HTML. "<text>" will be not converted!
  6926.  
  6927.  See:             !html, !ifdest, raw environment
  6928.  
  6929.  
  6930. F.8.3  !heading
  6931. ---------------
  6932.  
  6933.  Type & position: command, main part
  6934.  
  6935.  Syntax:          !heading <text>
  6936.  
  6937.  Description:     This  command  prints  out  "<text>" like a headline
  6938.                   using the chapter font and fontsize.
  6939.  
  6940.  Example:         !heading A headline
  6941.  
  6942.  See:             !subheading, !subsubheading, !subsubsubheading
  6943.  
  6944.  
  6945. F.8.4  !hline
  6946. -------------
  6947.  
  6948.  Type & position: command, main part
  6949.  
  6950.  Syntax:          !hline
  6951.  
  6952.  Description:     This  command  displays  a  horizontal  line  inside
  6953.                   normal  text  or inside a table. Not all destination
  6954.                   formats support horizontal lines.
  6955.  
  6956.  See:             Tables
  6957.  
  6958.  
  6959. F.8.5  !htag
  6960. ------------
  6961.  
  6962.  Type & position: command, preamble & main part
  6963.  
  6964.  Syntax:          !htag <text>
  6965.  
  6966.  Description:     "<text>" will only be printed if  you  convert  into
  6967.                   Helptag. "<text>" will be not converted!
  6968.  
  6969.  See:             !=htag, !ifdest, raw environment
  6970.  
  6971.  
  6972. F.8.6  !htag_img_suffix
  6973. -----------------------
  6974.  
  6975.  Type & position: switch, preamble & main part
  6976.  
  6977.  Syntax:          !htag_img_suffix <suffix>
  6978.  
  6979.  Description:     UDO uses the suffix "tiff" when converting the image
  6980.                   commands for HP HelpTag SGML by default. If you want
  6981.                   to  use  different  image types you can redefine the
  6982.                   image suffix with this command.  The  lower  example
  6983.                   shows  how  to change the image suffix to "xwd". You
  6984.                   can use !htag_img_suffix as often as you want so you
  6985.                   can  redefine  the  image  suffix right before every
  6986.                   image.
  6987.  
  6988.  Example:         !htag_img_suffix xwd
  6989.  
  6990.  See:             !image, (!img [ ]), Images
  6991.  
  6992.  
  6993. F.8.7  !html
  6994. ------------
  6995.  
  6996.  Type & position: command, preamble & main part
  6997.  
  6998.  Syntax:          !html <text>
  6999.  
  7000.  Description:     "<text>" will only be printed if  you  convert  into
  7001.                   HTML. "<text>" will be not converted!
  7002.  
  7003.  Example:         !html <hr>
  7004.  
  7005.  See:             !=html, !ifdest, raw environment
  7006.  
  7007.  
  7008. F.8.8  !html_backpage
  7009. ---------------------
  7010.  
  7011.  Type & position: command, preamble
  7012.  
  7013.  Syntax:          !html_backpage <URL>
  7014.  
  7015.  Description:     Using this command you can tell UDO where to jump to
  7016.                   when the reader clicks on the "Go Up" button on  the
  7017.                   title page.
  7018.  
  7019.  Example:         !html_backpage ../index.html
  7020.  
  7021.  See:             !no_headlines, !no_bottomlines
  7022.  
  7023.  
  7024. F.8.9  !html_img_suffix
  7025. -----------------------
  7026.  
  7027.  Type & position: switch, preamble & main part
  7028.  
  7029.  Syntax:          !html_img_suffix <suffix>
  7030.  
  7031.  Description:     UDO  uses the suffix "gif" when converting the image
  7032.                   commands for HTML by default. If  you  want  to  use
  7033.                   different  image  types  you  can redefine the image
  7034.                   suffix with this command. The  lower  example  shows
  7035.                   how  to  change  the image suffix to "jpeg". You can
  7036.                   use !html_img_suffix as often as you want so you can
  7037.                   redefine the image suffix right before every image.
  7038.  
  7039.  Example:         !html_img_suffix jpeg
  7040.  
  7041.  See:             !image, (!img [ ]), Images
  7042.  
  7043.  
  7044. F.8.10  !html_keywords
  7045. ----------------------
  7046.  
  7047.  Type & position: command, main part
  7048.  
  7049.  Syntax:          !html_keywords <text>
  7050.  
  7051.  Description:     <text should  be a comma separated list of keywords.
  7052.                   This list will be printed by UDO inside  the  header
  7053.                   of the HTML file that contains the chapter where you
  7054.                   used this comand. Some Internat machines are  taking
  7055.                   these information for referencing the HTML pages.
  7056.  
  7057.  Example:         !html_keywords   Dirk   Hagedorn,   UDO6,  Software,
  7058.                   Converter
  7059.  
  7060.  
  7061. F.8.11  !html_merge_nodes
  7062. -------------------------
  7063.  
  7064.  Type & position: switch, preamble
  7065.  
  7066.  Syntax:          !html_merge_nodes
  7067.  
  7068.  Description:     If you use this switch inside the preamble  of  your
  7069.                   UDO  source  file  UDO  will save only one HTML file
  7070.                   that will contain the whole text.
  7071.  
  7072.  See:             !html_merge_subnodes,       !html_merge_subsubnodes,
  7073.                   !html_merge_subsubsubnodes
  7074.  
  7075.  
  7076. F.8.12  !html_merge_subnodes
  7077. ----------------------------
  7078.  
  7079.  Type & position: switch, preamble
  7080.  
  7081.  Syntax:          !html_merge_subnodes
  7082.  
  7083.  Description:     If  you  use this switch inside the preamble of your
  7084.                   source file UDO will save  an  HTML  file  for  each
  7085.                   chapter.  These  files  will  contain  the sections,
  7086.                   subsections and paragraphs, too.
  7087.  
  7088.  See:             !html_merge_nodes,          !html_merge_subsubnodes,
  7089.                   !html_merge_subsubsubnodes
  7090.  
  7091.  
  7092. F.8.13  !html_merge_subsubnodes
  7093. -------------------------------
  7094.  
  7095.  Type & position: switch, preamble
  7096.  
  7097.  Syntax:          !html_merge_subsubnodes
  7098.  
  7099.  Description:     If  you  use this switch inside the preamble of your
  7100.                   source file UDO will save  an  HTML  file  for  each
  7101.                   section.  These  files  will contain the subsections
  7102.                   and paragraphs, too.
  7103.  
  7104.  See:             !html_merge_nodes,             !html_merge_subnodes,
  7105.                   !html_merge_subsubsubnodes
  7106.  
  7107.  
  7108. F.8.14  !html_merge_subsubsubnodes
  7109. ----------------------------------
  7110.  
  7111.  Type & position: switch, preamble
  7112.  
  7113.  Syntax:          !html_merge_subsubsubnodes
  7114.  
  7115.  Description:     If  you  use this switch inside the preamble of your
  7116.                   source file UDO will save  an  HTML  file  for  each
  7117.                   subsection. These files will contain the paragraphs,
  7118.                   too.
  7119.  
  7120.  See:             !html_merge_nodes,             !html_merge_subnodes,
  7121.                   !html_merge_subsubnodes
  7122.  
  7123.  
  7124. F.8.15  !html_name
  7125. ------------------
  7126.  
  7127.  Type & position: command, main part
  7128.  
  7129.  Syntax:          !html_name <file>
  7130.  
  7131.  Description:     If  you  use this command inside a chapter, section,
  7132.                   subsection or paragraph, "<file>"  is  used  as  the
  7133.                   name  of  the  HTML  file  instead  of  CCSSUUPP (CC
  7134.                   chapter, SS section, UU subsection, PP paragraph).
  7135.  
  7136.  Example:         !html_name software
  7137.  
  7138.  
  7139. F.8.16  !html_nodesize
  7140. ----------------------
  7141.  
  7142.  Type & position: switch, preamble
  7143.  
  7144.  Syntax:          !html_nodesize <value>
  7145.  
  7146.  Description:     You can set the font size of the HTML headlines with
  7147.                   this  switch.  By  default  UDO will use value of 1.
  7148.                   That means, that  UDO  will  print  <H1>...</H1> for
  7149.                   chapters, <H2>...</H2> for sections etc. The example
  7150.                   shows  how  to  tell  UDO  that  it   should   print
  7151.                   <H2>...</H2> for chapters etc.
  7152.  
  7153.  Example:         !html_nodesize 2
  7154.  
  7155.  See:             !node, !subnode, !subsubnode, !subsubsubnode
  7156.  
  7157.  
  7158. F.8.17  !html_use_xlist
  7159. -----------------------
  7160.  
  7161.  Type & position: switch, preamble
  7162.  
  7163.  Syntax:          !html_use_xlist
  7164.  
  7165.  Description:     Because  the  output of an xlist environment is very
  7166.                   complicated  these  environments  are  handled  like
  7167.                   description environments by default. Use this switch
  7168.                   inside the preamble to  display  xlist  environments
  7169.                   like  in  ASCII and with the use of the preformatted
  7170.                   tag.
  7171.  
  7172.  See:             Lists, Descriptions
  7173.  
  7174.  
  7175. F.8.18  !hyphen
  7176. ---------------
  7177.  
  7178.  Type & position: command, preamble
  7179.  
  7180.  Syntax:          !hyphen <word>
  7181.  
  7182.  Description:     You can  set  syllabification  marks  (!-)  with  this
  7183.                   command  for  a word for the whole text. The example
  7184.                   shows how to tell UDO where it's allowed to split up
  7185.                   the word "syllabification".
  7186.  
  7187.  Example:         !hyphen syl!-labi!-fi!-ca!-tion
  7188.  
  7189.  See:             Syllabification, !sloppy, !fussy, !-
  7190.  
  7191.  
  7192. F.9  I...
  7193. =========
  7194.  
  7195.  
  7196. F.9.1  !=info
  7197. -------------
  7198.  
  7199.  Type & position: command, preamble & main part
  7200.  
  7201.  Syntax:          !=info <text>
  7202.  
  7203.  Description:     "<text>"  will  only be printed if you don't convert
  7204.                   into Texinfo "<text>" will be not converted!
  7205.  
  7206.  See:             !info, !ifdest, raw environment
  7207.  
  7208.  
  7209. F.9.2  !if
  7210. ----------
  7211.  
  7212.  Type & position: command, preamble & main part
  7213.  
  7214.  Syntax:          !if [<text>]
  7215.  
  7216.  Description:     This command combines the commands !ifdest, !iflang,
  7217.                   !ifset and  !ifos.  The example shows how to test if
  7218.                   the source file is converted into  an  English  HTML
  7219.                   file.
  7220.  
  7221.  Example:         !if [english,html]
  7222.  
  7223.  See:             !iflang, !ifdest, !ifset, !ifos, Query commands
  7224.  
  7225.  
  7226. F.9.3  !ifdest
  7227. --------------
  7228.  
  7229.  Type & position: command, preamble & main part
  7230.  
  7231.  Syntax:          !ifdest [<abbreviations>]
  7232.  
  7233.  Description:     This  command  tests the current destination format.
  7234.                   If  one  of  the   "<abbreviations>"   matches   the
  7235.                   abbreviation  of  the  destination  format  UDO will
  7236.                   convert  all  lines  between  !ifdest and   !else or
  7237.                   !endif.  If  not  UDO  will  only  convert the lines
  7238.                   between  !else and  !endif if  !else is  used.   The
  7239.                   example  shows  how  to  test if UDO converts to ST-
  7240.                   Guide or Windows Help.
  7241.  
  7242.  Example:         !ifdest [stg,win]
  7243.  
  7244.  See:             !else, !endif, !ifndest, !if, Query commands
  7245.  
  7246.  
  7247. F.9.4  !iflang
  7248. --------------
  7249.  
  7250.  Type & position: command, preamble & main part
  7251.  
  7252.  Syntax:          !iflang [<languages>]
  7253.  
  7254.  Description:     This command test the language UDO uses for the des-
  7255.                   tination  file.  If  "<language>" matches one of the
  7256.                   abbreviations for the destination languages UDO will
  7257.                   convert   all  lines  between  !iflang and  !else or
  7258.                   !endif. If not  UDO  will  only  convert  the  lines
  7259.                   between   !else and  !endif if  !else is  used.  The
  7260.                   example  shows  how  to  test  if  UDO  converts  to
  7261.                   English.
  7262.  
  7263.  Example:         !iflang [english]
  7264.  
  7265.  See:             !ifnlang, !ifdest, !language, Query commands
  7266.  
  7267.  
  7268. F.9.5  !ifndest
  7269. ---------------
  7270.  
  7271.  Type & position: command, preamble & main part
  7272.  
  7273.  Syntax:          !ifndest [<abbreviation>]
  7274.  
  7275.  Description:     This  command  tests the current destination format.
  7276.                   If   none of   the   "<abbreviations>"   match   the
  7277.                   abbreviation  of  the  destination  format  UDO will
  7278.                   convert  all  lines  between  !ifdest and   !else or
  7279.                   !endif.  If  one  matches them UDO will only convert
  7280.                   the lines between !else and !endif if !else is used.
  7281.                   The example shows how to test if UDO doesn't convert
  7282.                   to HTML.
  7283.  
  7284.  Example:         !ifndest [html]
  7285.  
  7286.  See:             !else, !endif, !ifdest, Query commands
  7287.  
  7288.  
  7289. F.9.6  !ifnlang
  7290. ---------------
  7291.  
  7292.  Type & position: command, preamble & main part
  7293.  
  7294.  Syntax:          !ifnlang [<languages>]
  7295.  
  7296.  Description:     This command tests the current destination language.
  7297.                   If  none of the "<languages>" match the abbreviation
  7298.                   of the destination language  UDO  will  convert  all
  7299.                   lines  between  !ifdest and  !else or !endif. If one
  7300.                   matches them UDO will only convert the lines between
  7301.                   !else and !endif if !else is used. The example shows
  7302.                   how to test if UDO doesn't convert to French.
  7303.  
  7304.  Example:         !ifnlang [french]
  7305.  
  7306.  See:             !ifnlang, !ifdest, !language, Query commands
  7307.  
  7308.  
  7309. F.9.7  !ifnos
  7310. -------------
  7311.  
  7312.  Type & position: command, preamble & main part
  7313.  
  7314.  Syntax:          !ifnos [<systems>]
  7315.  
  7316.  Description:     This command tests the current operating system  UDO
  7317.                   is  running  on. If "<systems>" doesn't match any of
  7318.                   the abbreviations of the operating systems UDO  will
  7319.                   convert  all  lines that follow !else if it is used.
  7320.                   If !else isn't used UDO will ignore all lines  until
  7321.                   an !endif. The example shows how you can test if UDO
  7322.                   !doesn't run on an Apple Macintosh.
  7323.  
  7324.  Example:         !ifnos [macos]
  7325.  
  7326.  See:             !ifos
  7327.  
  7328.  
  7329. F.9.8  !ifnset
  7330. --------------
  7331.  
  7332.  Type & position: command, preamble & main part
  7333.  
  7334.  Syntax:          !ifnset [<text>]
  7335.  
  7336.  Description:     With this command you can test if a  symbol  !wasn't
  7337.                   set with the command line option -D or with !set. If
  7338.                   <text> wasn't set UDO will convert all lines bewteen
  7339.                   !ifnset and  !else or  !endif. If <text> was set UDO
  7340.                   will convert all lines between  !else and  !endif if
  7341.                   !else was used. The example shows how to test if the
  7342.                   symbol "british" isn't set.
  7343.  
  7344.  Example:         !ifnset [british]
  7345.  
  7346.  See:             !ifset
  7347.  
  7348.  
  7349. F.9.9  !ifos
  7350. ------------
  7351.  
  7352.  Type & position: command, preamble & main part
  7353.  
  7354.  Syntax:          !ifos [<text>]
  7355.  
  7356.  Description:     This command tests the current operating system  UDO
  7357.                   is  running  on. If "<systems>" match one of the ab-
  7358.                   breviations  of  the  operating  systems  UDO   will
  7359.                   convert  all  lines  that are used between !ifos and
  7360.                   !endif or !else. If "<systems>" doesn't match any of
  7361.                   the  abbreviations of the operating systems UDO will
  7362.                   ignore all lines before !endif or !else. The example
  7363.                   shows how you can test if UDO runs with Linux.
  7364.  
  7365.  Example:         !ifos [linux]
  7366.  
  7367.  See:             !ifnos
  7368.  
  7369.  
  7370. F.9.10  !ifset
  7371. --------------
  7372.  
  7373.  Type & position: command, preamble & main part
  7374.  
  7375.  Syntax:          !ifset [<text>]
  7376.  
  7377.  Description:     With  this  command you can test if a symbol was set
  7378.                   with the command line option  -D or  with  !set.  If
  7379.                   <text> was  set  UDO  will convert all lines bewteen
  7380.                   !ifset and !else or !endif. If <text> wasn't set UDO
  7381.                   will  convert  all lines between !else and !endif if
  7382.                   !else was used. The example shows how to test if the
  7383.                   symbol "british" was set.
  7384.  
  7385.  Example:         !ifset [british]
  7386.  
  7387.  See:             !ifnset
  7388.  
  7389.  
  7390. F.9.11  !ignore_bottomline
  7391. --------------------------
  7392.  
  7393.  Type & position: switch, preamble
  7394.  
  7395.  Syntax:          !ignore_bottomline
  7396.  
  7397.  Description:     If  this  switch  is used inside a chapter UDO won't
  7398.                   print a headline.  In  contrast  to  !no_bottomlines
  7399.                   this  switch  will only suppress the headline inside
  7400.                   the chapter where !ignore_bottomline is used.
  7401.  
  7402.  See:             !no_bottomlines
  7403.  
  7404.  
  7405. F.9.12  !ignore_headline
  7406. ------------------------
  7407.  
  7408.  Type & position: switch, preamble
  7409.  
  7410.  Syntax:          !ignore_headline
  7411.  
  7412.  Description:     If this switch is used inside a  chapter  UDO  won't
  7413.                   print  a headline. In contrast to !no_headlines this
  7414.                   switch will only suppress the  headline  inside  the
  7415.                   chapter where !ignore_headline is used.
  7416.  
  7417.  See:             !no_headlines
  7418.  
  7419.  
  7420. F.9.13  !ignore_index
  7421. ---------------------
  7422.  
  7423.  Type & position: switch, main part
  7424.  
  7425.  Syntax:          !ignore_index
  7426.  
  7427.  Description:     If  this  switch  is used inside a chapter UDO won't
  7428.                   add its title  to  the  index  even  if  the  switch
  7429.                   !use_nodes_inside_index is  used inside the preamble
  7430.                   of the source file.
  7431.  
  7432.  See:             !use_nodes_inside_index, !no_index, Indices
  7433.  
  7434.  
  7435. F.9.14  !ignore_links
  7436. ---------------------
  7437.  
  7438.  Type & position: switch, main part
  7439.  
  7440.  Syntax:          !ignore_links
  7441.  
  7442.  Description:     If this switch is part of a chapter UDO won't insert
  7443.                   links  to  this chapter automatically. You are still
  7444.                   able to insert links with !link ...) on your own.
  7445.  
  7446.  See:             Links, (!link ...)
  7447.  
  7448.  
  7449. F.9.15  !ignore_subsubsubtoc
  7450. ----------------------------
  7451.  
  7452.  Type & position: switch, main part
  7453.  
  7454.  Syntax:          !ignore_subsubsubtoc
  7455.  
  7456.  Description:     If this switch is used inside a subsection UDO won't
  7457.                   print a "subsubsubtoc" which contains all paragraphs
  7458.                   of  this  subsection   even   if   you   have   used
  7459.                   !use_auto_subsubsubtocs inside the preamble.
  7460.  
  7461.  See:             !use_auto_subsubsubtocs, !subsubsubtoc
  7462.  
  7463.  
  7464. F.9.16  !ignore_subsubtoc
  7465. -------------------------
  7466.  
  7467.  Type & position: switch, main part
  7468.  
  7469.  Syntax:          !ignore_subsubtoc
  7470.  
  7471.  Description:     If  this  switch  is used inside a section UDO won't
  7472.                   print a "subsubtoc" which contains  all  subsections
  7473.                   and paragraphs of this section even if you have used
  7474.                   !use_auto_subsubtocs inside the preamble.
  7475.  
  7476.  See:             !use_auto_subsubtocs, !subsubtoc
  7477.  
  7478.  
  7479. F.9.17  !ignore_subtoc
  7480. ----------------------
  7481.  
  7482.  Type & position: switch, main part
  7483.  
  7484.  Syntax:          !ignore_subtoc
  7485.  
  7486.  Description:     If this switch is used inside a  chapter  UDO  won't
  7487.                   print   a  "subtoc"  which  contains  all  sections,
  7488.                   subsections and paragraphs of this chapter  even  if
  7489.                   you have used !use_auto_subtocs inside the preamble.
  7490.  
  7491.  See:             !use_auto_subtocs, !subtoc
  7492.  
  7493.  
  7494. F.9.18  !image
  7495. --------------
  7496.  
  7497.  Type & position: command, main part
  7498.  
  7499.  Syntax:          !image <file> <caption>
  7500.  
  7501.  Description:     A  command  to  include an image is generated in the
  7502.                   destination  file,  if  it  supports   images.   You
  7503.                   shouldn't  pass  the  suffix  of  the  wanted  image
  7504.                   because UDO itself adds the right one.  It  will  be
  7505.                   .img for  the  ST-Guide, CSTeX and Lindner-TeX, .gif
  7506.                   for  HTML,  .msp or  .pcx for  emTeX  and   .bmp for
  7507.                   Windows  Help.  If  `<caption>'  is  used it will be
  7508.                   printed as the title of this
  7509.  
  7510.  Example:         !image tiger
  7511.  
  7512.  See:             !no_images, (!image ...), Images, !html_img_suffix
  7513.  
  7514.  
  7515. F.9.19  !image*
  7516. ---------------
  7517.  
  7518.  Type & position: command, main part
  7519.  
  7520.  Syntax:          !image* <file> <caption>
  7521.  
  7522.  Description:     There's one difference between  !image* and  !image.
  7523.                   If  you  use  this  command there will be printed no
  7524.                   table number.
  7525.  
  7526.  Example:         !image* tiger This is a tiger
  7527.  
  7528.  See:             !image
  7529.  
  7530.  
  7531. F.9.20  !image_counter
  7532. ----------------------
  7533.  
  7534.  Type & position: switch, preamble
  7535.  
  7536.  Syntax:          !image_counter [<value>]
  7537.  
  7538.  Description:     With this switch you can set the image  counter.  If
  7539.                   you  use  the lower example the caption of the first
  7540.                   image will look like this: "Figure 5: ...".
  7541.  
  7542.  Example:         !image_counter 5
  7543.  
  7544.  See:             Images
  7545.  
  7546.  
  7547. F.9.21  !include
  7548. ----------------
  7549.  
  7550.  Type & position: command, preamble & main part
  7551.  
  7552.  Syntax:          !include <file>
  7553.  
  7554.  Description:     Opens  the  file  named  "file"  and  converts   its
  7555.                   contents.
  7556.  
  7557.  Example:         !include macros.ui
  7558.  
  7559.  See:             !vinclude, !rinclude, Split documents
  7560.  
  7561.  
  7562. F.9.22  !index
  7563. --------------
  7564.  
  7565.  Type & position: command, main part
  7566.  
  7567.  Syntax:          !index <text>
  7568.  
  7569.  Description:     <text> will  pe  printed  as \index {...} for LaTeX,
  7570.                   K{\footnote K ...} for WinHelp, {\xe\v ...} for  RTF
  7571.                   and  @index  ... for ST-Guide. So, <text> appears in
  7572.                   the index of LaTeX and ST-Guide. WinHelp  allows  to
  7573.                   search  this  word. You can use this command as many
  7574.                   times as you like.
  7575.  
  7576.  Example:         !index entry !! index
  7577.  
  7578.  See:             Indices, !no_index
  7579.  
  7580.  
  7581. F.9.23  !info
  7582. -------------
  7583.  
  7584.  Type & position: command, preamble & main part
  7585.  
  7586.  Syntax:          !info <text>
  7587.  
  7588.  Description:     "<text>" is only  given  out  if  you  convert  into
  7589.                   Texinfo. "<text>" will be not converted!
  7590.  
  7591.  See:             !=info, !ifdest, raw environment
  7592.  
  7593.  
  7594. F.9.24  !item
  7595. -------------
  7596.  
  7597.  Type & position: command, main part
  7598.  
  7599.  Syntax:          !item <text>
  7600.  
  7601.  Description:     Starts  a  new item of an itemize or enumerate envi-
  7602.                   ronment.
  7603.  
  7604.  Example:         !item This is the next item
  7605.  
  7606.  See:             !item [ ], Itemizations, Enumerations
  7607.  
  7608.  
  7609. F.9.25  !item [ ]
  7610. -----------------
  7611.  
  7612.  Type & position: command, main part
  7613.  
  7614.  Syntax:          !item [<text>]
  7615.  
  7616.  Description:     Starts a new item of a description or an xlist envi-
  7617.                   ronment.  "<text>"  will  be  displayed in bold text
  7618.                   inside a description environment.
  7619.  
  7620.  Example:         !item [Title:] Description
  7621.  
  7622.  See:             !item, Descriptions, Lists
  7623.  
  7624.  
  7625. F.9.26  (!I)...(!i)
  7626. -------------------
  7627.  
  7628.  Type & position: placeholder, preamble & main part
  7629.  
  7630.  Syntax:          (!I)<text>(!i)
  7631.  
  7632.  Description:     "<text>" will be displayed in italics if possible.
  7633.  
  7634.  Example:         (!I)italic(!i)
  7635.  
  7636.  See:             Emphasizing text
  7637.  
  7638.  
  7639. F.9.27  (!idx ...)
  7640. ------------------
  7641.  
  7642.  Type & position: placeholder, main part
  7643.  
  7644.  Syntax:          (!idx     [<text>]     {[<index1>]}     {[<index2>]}
  7645.                   {[<index3>]} )
  7646.  
  7647.  Description:     Useful  for  adding  indices right inside the source
  7648.                   file.
  7649.  
  7650.  Example:         (!idx [word] [index entry])
  7651.  
  7652.  See:             Indices, !no_index, !index
  7653.  
  7654.  
  7655. F.9.28  (!ilink ...)
  7656. --------------------
  7657.  
  7658.  Type & position: placeholder, main part
  7659.  
  7660.  Syntax:          (!ilink [<file>] [<text>] [<link>])
  7661.  
  7662.  Description:     This placeholder is a combination of (!img ...)  and
  7663.                   (!link ...)  and is useful to display an image right
  7664.                   inside the text. If you click this  image  you  will
  7665.                   jump  to  another  part of the document. The example
  7666.                   shows how to display an image called disk.[bmp,gif],
  7667.                   the   link   destination   is  "Download".  In  HTML
  7668.                   "download UDO" will be used as the alternative text.
  7669.                   In  all  other  formats  only "download" UDO will be
  7670.                   dislayed.
  7671.  
  7672.  Example:         (!ilink [disk] [download UDO] [Download]
  7673.  
  7674.  See:             (!img~..), (!link ...), Links, Images
  7675.  
  7676.  
  7677. F.9.29  (!img ...)
  7678. ------------------
  7679.  
  7680.  Type & position: placeholder, main part
  7681.  
  7682.  Syntax:          (!img [<file>] [<text>])
  7683.  
  7684.  Description:     Use this placeholder to use an  image  right  inside
  7685.                   the  text of HTML or WinHelp. If another destination
  7686.                   format will be used only "<text>" will be displayed.
  7687.                   When  converting to HTML file.gif will be used, when
  7688.                   converting to WinHelp file.bmp  will  be  used.  UDO
  7689.                   doesn't check if this file exists.
  7690.  
  7691.  Example:         (!img [dh] [my logotype])
  7692.  
  7693.  See:             Images, !image
  7694.  
  7695.  
  7696. F.10  L...
  7697. ==========
  7698.  
  7699.  
  7700. F.10.1  !=ldoc
  7701. --------------
  7702.  
  7703.  Type & position: command, preamble & main part
  7704.  
  7705.  Syntax:          !=ldoc <text>
  7706.  
  7707.  Description:     "<text>"  will  only be printed if you don't convert
  7708.                   into Linuxdoc-SGML. "<text>" will be not converted!
  7709.  
  7710.  See:             !ldoc, !ifdest, raw environment
  7711.  
  7712.  
  7713. F.10.2  !label
  7714. --------------
  7715.  
  7716.  Type & position: command, main part
  7717.  
  7718.  Syntax:          !label <text>
  7719.  
  7720.  Description:     Defines  a  label  that  will   be   referenced   in
  7721.                   hypertexts or can be accessed by a link command
  7722.  
  7723.  Example:         !label Label
  7724.  
  7725.  See:             Labels, (!link ...), (!plink ...)
  7726.  
  7727.  
  7728. F.10.3  !language
  7729. -----------------
  7730.  
  7731.  Type & position: command, preamble
  7732.  
  7733.  Syntax:          !language [<languages>]
  7734.  
  7735.  Description:     With this command you can tell UDO which language it
  7736.                   should  use  for  the  date  and  expressions   like
  7737.                   "Table",  "Contents"  or  "Appendix".  UDO  will use
  7738.                   German expressions by default. The example shows how
  7739.                   to change the language to English.
  7740.  
  7741.  Example:         !language english
  7742.  
  7743.  See:             !iflang, !ifnlang, (!today)
  7744.  
  7745.  
  7746. F.10.4  !ldoc
  7747. -------------
  7748.  
  7749.  Type & position: command, preamble & main part
  7750.  
  7751.  Syntax:          !ldoc <text>
  7752.  
  7753.  Description:     "<text>"  is  only  given  out  if  you convert into
  7754.                   Linuxdoc-SGML. "<text>" will be not converted!
  7755.  
  7756.  See:             !=ldoc, !ifdest, raw environment
  7757.  
  7758.  
  7759. F.10.5  !listoffigures
  7760. ----------------------
  7761.  
  7762.  Type & position: command, main part
  7763.  
  7764.  Syntax:          !listoffigures
  7765.  
  7766.  Description:     This command prints a list of  figures.  You  should
  7767.                   use  it  directly after !tableofcontents if you want
  7768.                   to use it. At the moment this command will  only  be
  7769.                   converted for LaTeX.
  7770.  
  7771.  See:             !image, !tableofcontents, !listoftables
  7772.  
  7773.  
  7774. F.10.6  !listoftables
  7775. ---------------------
  7776.  
  7777.  Type & position: command, main part
  7778.  
  7779.  Syntax:          !listoftables
  7780.  
  7781.  Description:     This command prints a list of tables. You should use
  7782.                   it directly after !tableofcontents or !listoffigures
  7783.                   if  you  want  to use it. At the moment this command
  7784.                   will only be converted for LaTeX.
  7785.  
  7786.  See:             Tabellen, !tableofcontents, !listoffigures
  7787.  
  7788.  
  7789. F.10.7  (!LaTeX)
  7790. ----------------
  7791.  
  7792.  Type & position: placeholder, preamble & main part
  7793.  
  7794.  Syntax:          (!LaTeX)
  7795.  
  7796.  Description:     This placeholder will be replaced  by  \LaTeX{} when
  7797.                   converting to LaTeX. Otherwise it will be replace by
  7798.                   "LaTeX".
  7799.  
  7800.  See:             (!TeX), (!LaTeXe)
  7801.  
  7802.  
  7803. F.10.8  (!LaTeXe)
  7804. -----------------
  7805.  
  7806.  Type & position: placeholder, preamble & main part
  7807.  
  7808.  Syntax:          (!LaTeXe)
  7809.  
  7810.  Description:     This placeholder will be replaced by  \LaTeXe{} when
  7811.                   converting to LaTeX. Otherwise it will be replace by
  7812.                   "LaTeX2e".
  7813.  
  7814.  See:             (!TeX), (!LaTeX)
  7815.  
  7816.  
  7817. F.10.9  (!laugh)
  7818. ----------------
  7819.  
  7820.  Type & position: placeholder, preamble & main part
  7821.  
  7822.  Syntax:          (!laugh)
  7823.  
  7824.  Description:     (!laugh) will be replaced  by  a  laughing  emoticon
  7825.                   displayed in typewriter.
  7826.  
  7827.  Example:         (!laugh) becomes :-)
  7828.  
  7829.  See:             (!grin)
  7830.  
  7831.  
  7832. F.10.10  (!link~..)
  7833. -------------------
  7834.  
  7835.  Type & position: placeholder, main part
  7836.  
  7837.  Syntax:          (!link [<text>] [<link>])
  7838.  
  7839.  Description:     With  this placeholder you can define links to other
  7840.                   parts of  the  document.  See  section  "Links"  for
  7841.                   further information.
  7842.  
  7843.  Example:         (!link [me] [Contact addresses])
  7844.  
  7845.  See:             (!xlink ...), (!plink ...), Links
  7846.  
  7847.  
  7848. F.11  M...
  7849. ==========
  7850.  
  7851.  
  7852. F.11.1  !=man
  7853. -------------
  7854.  
  7855.  Type & position: command, preamble
  7856.  
  7857.  Syntax:          !=man <text>
  7858.  
  7859.  Description:     "<text>"  will  only be printed if you don't convert
  7860.                   into a manualpage. "<text>" will be not converted!
  7861.  
  7862.  See:             !man, !ifdest, raw environment
  7863.  
  7864.  
  7865. F.11.2  !macro
  7866. --------------
  7867.  
  7868.  Type & position: command, preamble
  7869.  
  7870.  Syntax:          !macro <word> <text>
  7871.  
  7872.  Description:     Defines a macro. Later on every "(!<word>)" will  be
  7873.                   replaced  by  "<text>". When using the lower exmaple
  7874.                   every "(!DH)" will be replaced by "Dirk Hagedorn".
  7875.  
  7876.  Example:         !macro DH Dirk Hagedorn
  7877.  
  7878.  See:             Macros
  7879.  
  7880.  
  7881. F.11.3  !maketitle
  7882. ------------------
  7883.  
  7884.  Type & position: command, main part
  7885.  
  7886.  Syntax:          !maketitle
  7887.  
  7888.  Description:     Outputs a titlepage build with the  information  set
  7889.                   by  the  lower  commands.  !maketitle should be used
  7890.                   directly    after     !begin_document and     before
  7891.                   !tableofcontents.
  7892.  
  7893.  See:             Title page
  7894.  
  7895.  
  7896. F.11.4  !man
  7897. ------------
  7898.  
  7899.  Type & position: command, preamble & main part
  7900.  
  7901.  Syntax:          !man <text>
  7902.  
  7903.  Description:     "<text>"   is   printed   if   you  convert  into  a
  7904.                   manualpage. "<text>" will be not converted!
  7905.  
  7906.  See:             !=man, raw environment
  7907.  
  7908.  
  7909. F.11.5  !man_lpp
  7910. ----------------
  7911.  
  7912.  Type & position: command, preamble
  7913.  
  7914.  Syntax:          !man_lpp <value>
  7915.  
  7916.  Description:     Sets the  "lines  per  page"  of  a  manualpage.  If
  7917.                   <value>  is  bigger  than  0 UDO generates footlines
  7918.                   with  pagenumbers.  When  UDO  starts  !man_lpp   is
  7919.                   undefined and UDO won't generate these footlines.
  7920.  
  7921.  Example:         !man_lpp 60
  7922.  
  7923.  See:             !use_formfeed
  7924.  
  7925.  
  7926. F.11.6  !man_type
  7927. -----------------
  7928.  
  7929.  Type & position: command, preamble
  7930.  
  7931.  Syntax:          !man_type <text>
  7932.  
  7933.  Description:     When  converting into a manualpage UDO uses "<text>"
  7934.                   inside the headline with brackets. The  exmaple  and
  7935.                   "!program udo" would look like "udo(1)". UDO doesn't
  7936.                   use "<text>" as a file suffix.
  7937.  
  7938.  Example:         !man_type 1
  7939.  
  7940.  
  7941. F.11.7  !medskip
  7942. ----------------
  7943.  
  7944.  Type & position: command, main part
  7945.  
  7946.  Syntax:          !medskip
  7947.  
  7948.  Description:     This command will be simplay replaced by  `\medskip'
  7949.                   when  converted  to  LaTeX. Otherwise two additional
  7950.                   empty lines will be generated.
  7951.  
  7952.  See:             !smallskip, !bigskip
  7953.  
  7954.  
  7955. F.12  N...
  7956. ==========
  7957.  
  7958.  
  7959. F.12.1  !newpage
  7960. ----------------
  7961.  
  7962.  Type & position: command, main part
  7963.  
  7964.  Syntax:          !newpage
  7965.  
  7966.  Description:     Generates a page break  if  the  destination  format
  7967.                   supports it.
  7968.  
  7969.  See:             !use_formfeed
  7970.  
  7971.  
  7972. F.12.2  !no_bottomlines
  7973. -----------------------
  7974.  
  7975.  Type & position: switch, preamble
  7976.  
  7977.  Syntax:          !no_bottomlines [<abbreviations>]
  7978.  
  7979.  Description:     Tells  UDO  not  to  generate  bottomlines.  In  the
  7980.                   example this is done for the Pure C Help format.
  7981.  
  7982.  Example:         !no_bottomlines [pch]
  7983.  
  7984.  See:             !no_headlines, !ignore_bottomline
  7985.  
  7986.  
  7987. F.12.3  !no_effects
  7988. -------------------
  7989.  
  7990.  Type & position: switch, preamble
  7991.  
  7992.  Syntax:          !no_effects [<abbreviations>]
  7993.  
  7994.  Description:     Switches off  the  usage  of  text  emphasises.  The
  7995.                   exmaple shows how to switch it of when converting to
  7996.                   ASCII.
  7997.  
  7998.  Example:         !no_effects [asc]
  7999.  
  8000.  
  8001. F.12.4  !no_headlines
  8002. ---------------------
  8003.  
  8004.  Type & position: switch, preamble
  8005.  
  8006.  Syntax:          !no_headlines [<abbreviations>]
  8007.  
  8008.  Description:     Switches off the usage  of  headlines.  The  example
  8009.                   show  how  to  switch  it  off  when  converting  to
  8010.                   WinHelp.
  8011.  
  8012.  Example:         !no_headlines [win]
  8013.  
  8014.  See:             !no_bottomlines, !ignore_headline
  8015.  
  8016.  
  8017. F.12.5  !no_images
  8018. ------------------
  8019.  
  8020.  Type & position: switch, preamble
  8021.  
  8022.  Syntax:          !no_images [<abbreviations>]
  8023.  
  8024.  Description:     Switches off  the  output  of  commands  to  display
  8025.                   images.  The  example show how to switch it off when
  8026.                   converting to HTML.
  8027.  
  8028.  Example:         !no_images [html]
  8029.  
  8030.  See:             !image, Images
  8031.  
  8032.  
  8033. F.12.6  !no_index
  8034. -----------------
  8035.  
  8036.  Type & position: switch, preamble
  8037.  
  8038.  Syntax:          !no_index [<abbreviations>]
  8039.  
  8040.  Description:     If this switch  is  used  inside  the  preamble  UDO
  8041.                   suppresses  index commands for the given destination
  8042.                   formats. Furthermore neither UDO nor the destination
  8043.                   format will print an index. The example shows how to
  8044.                   suppress index commands for RTF.
  8045.  
  8046.  Example:         !no_index [rtf]
  8047.  
  8048.  See:             !index, (!idx ...)
  8049.  
  8050.  
  8051. F.12.7  !no_numbers
  8052. -------------------
  8053.  
  8054.  Type & position: switch, preamble
  8055.  
  8056.  Syntax:          !no_numbers [<abbreviations>]
  8057.  
  8058.  Description:     This command  switches  off  the  usage  of  chapter
  8059.                   numbers.  In  tables  of  contens  only  the chapter
  8060.                   titles will be displayed. The example shows  how  to
  8061.                   suppress them in Windows Help and HTML.
  8062.  
  8063.  Example:         !no_numbers [win,html]
  8064.  
  8065.  See:             !tableofcontents, !toc, !subtoc, !subsubtoc
  8066.  
  8067.  
  8068. F.12.8  !no_preamble
  8069. --------------------
  8070.  
  8071.  Type & position: switch, preamble
  8072.  
  8073.  Syntax:          !no_preamble [<abbreviations>]
  8074.  
  8075.  Description:     If  this  switch  is used inside the preamble of the
  8076.                   source file UDO won't print a specific preamble  for
  8077.                   the  destination  format.  The  example shows how to
  8078.                   suppress the preamble for LaTeX. You shall have some
  8079.                   knowledge  about  the destination format if you want
  8080.                   to write your own preamble.
  8081.  
  8082.  Example:         !no_preamble [tex]
  8083.  
  8084.  
  8085. F.12.9  !no_quotes
  8086. ------------------
  8087.  
  8088.  Type & position: switch, preamble
  8089.  
  8090.  Syntax:          !no_quotes [<abbreviations>]
  8091.  
  8092.  Description:     Says UDO not to replace  double  quotes  and  double
  8093.                   apostrophes by real quotes and apostrophes.
  8094.  
  8095.  Example:         !no_quotes [asc,man]
  8096.  
  8097.  See:             Double quotes, Double apostrophes
  8098.  
  8099.  
  8100. F.12.10  !no_toc_subnodes
  8101. -------------------------
  8102.  
  8103.  Type & position: switch, preamble
  8104.  
  8105.  Syntax:          !no_toc_subnodes
  8106.  
  8107.  Description:     If  you use this switch inside the preamble UDO will
  8108.                   print only the chapter titles inside  the  table  of
  8109.                   contents.    !no_toc_subnodes is    the    same   as
  8110.                   !use_short_toc.
  8111.  
  8112.  Example:         !no_toc_subnodes [win]
  8113.  
  8114.  See:             !tableofcontents
  8115.  
  8116.  
  8117. F.12.11  !no_toc_subsubnodes
  8118. ----------------------------
  8119.  
  8120.  Type & position: switch, preamble
  8121.  
  8122.  Syntax:          !no_toc_subsubnodes
  8123.  
  8124.  Description:     If you use this switch inside the preamble UDO  will
  8125.                   print  only  the  chapter  titles and section titles
  8126.                   inside the table of contents.
  8127.  
  8128.  Example:         !no_toc_subsubnodes [win,stg,html]
  8129.  
  8130.  See:             !tableofcontents
  8131.  
  8132.  
  8133. F.12.12  !no_toc_subsubsubnodes
  8134. -------------------------------
  8135.  
  8136.  Type & position: switch, preamble
  8137.  
  8138.  Syntax:          !no_toc_subsubsubnodes
  8139.  
  8140.  Description:     If you use this switch inside the preamble UDO  will
  8141.                   print  only  the  chapter titles, section titles and
  8142.                   subsection titles inside the table of contents.
  8143.  
  8144.  Example:         !no_toc_subsubsubnodes [win,stg,html]
  8145.  
  8146.  See:             !tableofcontents
  8147.  
  8148.  
  8149. F.12.13  !no_umlaute
  8150. --------------------
  8151.  
  8152.  Type & position: switch, preamble
  8153.  
  8154.  Syntax:          !no_umlaute [<abbreviations>]
  8155.  
  8156.  Description:     Switches  off  the  usage  of  German  umlauts.  The
  8157.                   example show how to switch it off when converting to
  8158.                   a manualpage. Umlauts are than replaced by  ae,  oe,
  8159.                   ue, ss, Ae, Oe and Ue.
  8160.  
  8161.  Example:         !no_umlaute [man]
  8162.  
  8163.  See:             Special characters
  8164.  
  8165.  
  8166. F.12.14  !no_verbatim_umlaute
  8167. -----------------------------
  8168.  
  8169.  Type & position: switch, preamble
  8170.  
  8171.  Syntax:          !no_verbatim_umlaute [<abbreviations>]
  8172.  
  8173.  Description:     Switches  off  the  usage of German umlauts inside a
  8174.                   verbatim environment. The example show how to switch
  8175.                   it  off  when  converting to LaTeX. Umlauts are than
  8176.                   replaced by ae, oe, ue, ss, Ae, Oe and Ue.
  8177.  
  8178.  Example:         !no_verbatim_umlaute [tex]
  8179.  
  8180.  See:             !begin_verbatim, !end_verbatim, Preformatted text
  8181.  
  8182.  
  8183. F.12.15  !no_xlinks
  8184. -------------------
  8185.  
  8186.  Type & position: switch, preamble
  8187.  
  8188.  Syntax:          !no_xlinks [<abbreviations>]
  8189.  
  8190.  Description:     This command switches  off  the  usage  of  external
  8191.                   links.  This  is  useful  if  you used external HTML
  8192.                   links in a source file that you want to  convert  to
  8193.                   another  format  that  supports  external links. The
  8194.                   example shows how to suppress the usage of  external
  8195.                   links when converting to ST-Guide.
  8196.  
  8197.  Example:         !no_xlink [stg]
  8198.  
  8199.  See:             (!xlink ...)
  8200.  
  8201.  
  8202. F.12.16  !node
  8203. --------------
  8204.  
  8205.  Type & position: command, main part
  8206.  
  8207.  Syntax:          !node <text>
  8208.  
  8209.  Description:     Starts a new chapter named "<text>".
  8210.  
  8211.  Example:         !node Command reference
  8212.  
  8213.  See:             !pnode,   !subnode,   !subsubnode,   !subsubsubnode,
  8214.                   Structuring
  8215.  
  8216.  
  8217. F.12.17  !node*
  8218. ---------------
  8219.  
  8220.  Type & position: command, main part
  8221.  
  8222.  Syntax:          !node* <text>
  8223.  
  8224.  Description:     This command  does  the  same  as  !node,  but  here
  8225.                   "<text>" will not appear in a table of contents.
  8226.  
  8227.  Example:         !node* Chapter title
  8228.  
  8229.  See:             !node, !pnode*, Structuring
  8230.  
  8231.  
  8232. F.12.18  !nop
  8233. -------------
  8234.  
  8235.  Type & position: command, preamble & main part
  8236.  
  8237.  Syntax:          !nop
  8238.  
  8239.  Description:     This  command  ("no  operation") does nothing and is
  8240.                   used for debugging purposes.
  8241.  
  8242.  
  8243. F.12.19  (!N)...(!n)
  8244. --------------------
  8245.  
  8246.  Type & position: placeholder, preamble & main part
  8247.  
  8248.  Syntax:          (!N)<text>(!n)
  8249.  
  8250.  Description:     "<text>" will be  displayed  as  a  footnote  or  in
  8251.                   brakes.  Right before (!N) shouldn't be a space, tab
  8252.                   or linefeed!
  8253.  
  8254.  Example:         the text(!N)the footnote(!n)
  8255.  
  8256.  See:             Footnotes
  8257.  
  8258.  
  8259. F.12.20  (!nl)
  8260. --------------
  8261.  
  8262.  Type & position: placeholder, main part
  8263.  
  8264.  Syntax:          (!nl)
  8265.  
  8266.  Description:     With (!nl) you can force a line break. You  must add
  8267.                   a space before (!nl) if you use it!
  8268.  
  8269.  Example:         breaking (!nl) lines
  8270.  
  8271.  
  8272. F.13  O...
  8273. ==========
  8274.  
  8275.  
  8276. F.14  P...
  8277. ==========
  8278.  
  8279.  
  8280. F.14.1  !=pch
  8281. -------------
  8282.  
  8283.  Type & position: command, preamble & main part
  8284.  
  8285.  Syntax:          !=pch <text>
  8286.  
  8287.  Description:     "<text>"  will  only be printed if you don't convert
  8288.                   into Pure C Help. "<text>" will be not converted!
  8289.  
  8290.  See:             !pch, !ifdest, raw environment
  8291.  
  8292.  
  8293. F.14.2  !parwidth
  8294. -----------------
  8295.  
  8296.  Type & position: switch, preamble
  8297.  
  8298.  Syntax:          !parwidth <value>
  8299.  
  8300.  Description:     With this switch you can tell  UDO  which  width  it
  8301.                   should  use  for  the lines it saves. UDO uses 70 by
  8302.                   default. You  can  change  this  value  by  using  a
  8303.                   <value> between  20  and  200.  When  converting  to
  8304.                   Windows Help, Apple QuickView or HTML you can use  a
  8305.                   value  that's greater than 200 if you use the switch
  8306.                   !use_output_buffer.
  8307.  
  8308.  Example:         !parwidth 98
  8309.  
  8310.  See:             !use_output_buffer
  8311.  
  8312.  
  8313. F.14.3  !pch
  8314. ------------
  8315.  
  8316.  Type & position: command, preamble & main part
  8317.  
  8318.  Syntax:          !pch <text>
  8319.  
  8320.  Description:     "<text>" is only given out if you convert into  Pure
  8321.                   C Help. "<text>" will be not converted!
  8322.  
  8323.  See:             !=pch, raw environment
  8324.  
  8325.  
  8326. F.14.4  !pnode
  8327. --------------
  8328.  
  8329.  Type & position: command, main part
  8330.  
  8331.  Syntax:          !pnode <text>
  8332.  
  8333.  Description:     The same as !node but the contents will be displayed
  8334.                   as a popup inside ST-Guide and WinHelp.
  8335.  
  8336.  Example:         !popup Popup title
  8337.  
  8338.  See:             !psubnode, !psubsubnode, !psubsubsubnode
  8339.  
  8340.  
  8341. F.14.5  !pnode*
  8342. ---------------
  8343.  
  8344.  Type & position: command, main part
  8345.  
  8346.  Syntax:          !pnode* <text>
  8347.  
  8348.  Description:     This command does  the  same  as  !pnode,  but  here
  8349.                   "<text>" will not appear in a table of contents.
  8350.  
  8351.  Example:         !pnode Popup title
  8352.  
  8353.  See:             !pnode, !node*, Structuring
  8354.  
  8355.  
  8356. F.14.6  !program
  8357. ----------------
  8358.  
  8359.  Type & position: command, preamble
  8360.  
  8361.  Syntax:          !program <text>
  8362.  
  8363.  Description:     "<text>"  will  be  displayed on the titlepage below
  8364.                   the title.
  8365.  
  8366.  Example:         !program UDO
  8367.  
  8368.  See:             !maketitle, !programimage, Title page
  8369.  
  8370.  
  8371. F.14.7  !programimage
  8372. ---------------------
  8373.  
  8374.  Type & position: command, preamble
  8375.  
  8376.  Syntax:          !programimage <file>
  8377.  
  8378.  Description:     "<file>" will be displayed instead of  the  name  of
  8379.                   the  program  on  the  titlepage  if the destination
  8380.                   format supports images.
  8381.  
  8382.  Example:         !programimage udo
  8383.  
  8384.  See:             !maketitle, !program, Title page
  8385.  
  8386.  
  8387. F.14.8  !psubnode
  8388. -----------------
  8389.  
  8390.  Type & position: command, main part
  8391.  
  8392.  Syntax:          !psubnode <text>
  8393.  
  8394.  Description:     The  same  as  !subnode but  the  contents  will  be
  8395.                   displayed as a popup inside ST-Guide and WinHelp.
  8396.  
  8397.  Example:         !psubnode A popup section
  8398.  
  8399.  See:             !pnode, !psubsubnode, !psubsubsubnode
  8400.  
  8401.  
  8402. F.14.9  !psubnode*
  8403. ------------------
  8404.  
  8405.  Type & position: command, main part
  8406.  
  8407.  Syntax:          !psubnode* <text>
  8408.  
  8409.  Description:     This  command  does  the same as !psubnode, but here
  8410.                   "<text>" will not appear in a table of contents.
  8411.  
  8412.  Example:         !psubnode* A hidden popup section
  8413.  
  8414.  See:             !psubnode, !subnode*, Structuring
  8415.  
  8416.  
  8417. F.14.10  !psubsubnode
  8418. ---------------------
  8419.  
  8420.  Type & position: command, main part
  8421.  
  8422.  Syntax:          !psubsubnode <text>
  8423.  
  8424.  Description:     The same as !subsubnode but  the  contents  will  be
  8425.                   displayed as a popup inside ST-Guide and WinHelp.
  8426.  
  8427.  Example:         !psubsubnode A popup subsection
  8428.  
  8429.  See:             !pnode, !psubnode, !psubsubsubnode
  8430.  
  8431.  
  8432. F.14.11  !psubsubnode*
  8433. ----------------------
  8434.  
  8435.  Type & position: command, main part
  8436.  
  8437.  Syntax:          !psubsubnode* <text>
  8438.  
  8439.  Description:     This command does the same as !psubsubnode, but here
  8440.                   "<text>" will not appear in a table of contents.
  8441.  
  8442.  Example:         !psubsubnode* A hidden popup subsection
  8443.  
  8444.  See:             !psubsubnode, !subsubnode*, Structuring
  8445.  
  8446.  
  8447. F.14.12  !psubsubsubnode
  8448. ------------------------
  8449.  
  8450.  Type & position: command, main part
  8451.  
  8452.  Syntax:          !psubsubsubnode <text>
  8453.  
  8454.  Description:     The same as !subsubsubnode but the contents will  be
  8455.                   displayed as a popup inside ST-Guide and WinHelp.
  8456.  
  8457.  Example:         !psubsubsubnode A popup paragraph
  8458.  
  8459.  See:             !pnode, !psubnode, !psubsubnode
  8460.  
  8461.  
  8462. F.14.13  !psubsubsubnode*
  8463. -------------------------
  8464.  
  8465.  Type & position: command, main part
  8466.  
  8467.  Syntax:          !psubsubsubnode* <text>
  8468.  
  8469.  Description:     This  command  does the same as !psubsubsubnode, but
  8470.                   here "<text>"  will  not  appear  in  the  table  of
  8471.                   contents.
  8472.  
  8473.  Example:         !psubsubsubnode* A hidden popup paragraph
  8474.  
  8475.  See:             !pnode, !psubnode, !psubsubnode, !psubsubsubnode
  8476.  
  8477.  
  8478. F.14.14  (!plink~..)
  8479. --------------------
  8480.  
  8481.  Type & position: placeholder, main part
  8482.  
  8483.  Syntax:          (!plink [<text>] [<link>])
  8484.  
  8485.  Description:     Only  useful  when  converted  to  LaTeX  where it's
  8486.                   converted into a page reference.
  8487.  
  8488.  Example:         (!plink [word] [label])
  8489.  
  8490.  See:             (!link ...), (!xlink ...), Links
  8491.  
  8492.  
  8493. F.15  R...
  8494. ==========
  8495.  
  8496.  
  8497. F.15.1  !=rtf
  8498. -------------
  8499.  
  8500.  Type & position: command, preamble & main part
  8501.  
  8502.  Syntax:          !=rtf <text>
  8503.  
  8504.  Description:     "<text>" will only be printed if  you  don't convert
  8505.                   into RTF. "<text>" will be not converted!
  8506.  
  8507.  See:             !rtf, !ifdest, raw environment
  8508.  
  8509.  
  8510. F.15.2  !rinclude
  8511. -----------------
  8512.  
  8513.  Type & position: command, main part
  8514.  
  8515.  Syntax:          !rinclude <file>
  8516.  
  8517.  Description:     "<file>"  will  be included and output unforformated
  8518.                   inside a raw environment. Useful  for  large  tables
  8519.                   for LaTeX or HTML.
  8520.  
  8521.  Example:         !rinclude table.tex
  8522.  
  8523.  See:             !include,  !vinclude,  Split documents, raw environ-
  8524.                   ment
  8525.  
  8526.  
  8527. F.15.3  !rtf
  8528. ------------
  8529.  
  8530.  Type & position: command, preamble & main part
  8531.  
  8532.  Syntax:          !rtf <text>
  8533.  
  8534.  Description:     "<text>" is only given out if you convert into  RTF.
  8535.                   "<text>" will be not converted!
  8536.  
  8537.  See:             !=rtf, raw environment
  8538.  
  8539.  
  8540. F.15.4  !rtf_charwidth
  8541. ----------------------
  8542.  
  8543.  Type & position: switch, preamble & main part
  8544.  
  8545.  Syntax:          !rtf_charwidth <value>
  8546.  
  8547.  Description:     UDO  uses a constant value for calulating the indent
  8548.                   of lists and the widths of table cells.  This  value
  8549.                   works   even   fine  with  bold  monospaced  capital
  8550.                   letters, but if you use normal text the  indents  or
  8551.                   table  cells  my  be  too width. You can adjust this
  8552.                   value by  using  !rtf_charwidth.  UDO  uses  150  by
  8553.                   default.
  8554.  
  8555.  Example:         !rtf_charwidth 100
  8556.  
  8557.  See:             Tables, Lists
  8558.  
  8559.  
  8560. F.15.5  !rtf_monofont
  8561. ---------------------
  8562.  
  8563.  Type & position: command, preamble
  8564.  
  8565.  Syntax:          !rtf_monofont <fontname>
  8566.  
  8567.  Description:     With  this command you can set the font that will be
  8568.                   used to display preformated  text.  The  default  is
  8569.                   "Monospace 821".
  8570.  
  8571.  Example:         !rtf_monofont Courier New
  8572.  
  8573.  See:             !rtf_propfont
  8574.  
  8575.  
  8576. F.15.6  !rtf_no_tables
  8577. ----------------------
  8578.  
  8579.  Type & position: switch, preamble
  8580.  
  8581.  Syntax:          !rtf_no_tables
  8582.  
  8583.  Description:     If  you  use  this  command  inside the preamble UDO
  8584.                   prints tables without using special RTF commands. It
  8585.                   will  print  the  table ASCII like with a monospaced
  8586.                   font.
  8587.  
  8588.  See:             Tables
  8589.  
  8590.  
  8591. F.15.7  !rtf_propfont
  8592. ---------------------
  8593.  
  8594.  Type & position: command, preamble
  8595.  
  8596.  Syntax:          !rtf_propfont <fontname>
  8597.  
  8598.  Description:     With this command you can set the font that will  be
  8599.                   used  to  display  text and headings. The default is
  8600.                   "Dutch 801 Roman".
  8601.  
  8602.  Example:         !rtf_propfont Times New Roman
  8603.  
  8604.  See:             !rtf_monofont
  8605.  
  8606.  
  8607. F.16  S...
  8608. ==========
  8609.  
  8610.  
  8611. F.16.1  !=stg
  8612. -------------
  8613.  
  8614.  Type & position: command, preamble & main part
  8615.  
  8616.  Syntax:          !=stg <text>
  8617.  
  8618.  Description:     "<text>" will only be printed if  you  don't convert
  8619.                   into ST-Guide. "<text>" will be not converted!
  8620.  
  8621.  See:             !stg, !ifdest, raw environment
  8622.  
  8623.  
  8624. F.16.2  !set
  8625. ------------
  8626.  
  8627.  Type & position: command, preamble & main part
  8628.  
  8629.  Syntax:          !set <text>
  8630.  
  8631.  Description:     With  this  command  you can set symbols inside your
  8632.                   source file that you can check with !ifset and  !if.
  8633.                   Symbols  may  alos be set by the command line option
  8634.                   -D. With the !unset command you can delete  symbols.
  8635.                   You can use !set wherever you want.
  8636.  
  8637.  Example:         !set UseColourGraphics
  8638.  
  8639.  See:             !unset, !ifset, !ifnset
  8640.  
  8641.  
  8642. F.16.3  !short
  8643. --------------
  8644.  
  8645.  Type & position: switch, main part
  8646.  
  8647.  Syntax:          !short
  8648.  
  8649.  Description:     If  you  use  this switch together with environments
  8650.                   this specific environment will  be  printed  without
  8651.                   additional  vertical space. The example shows how to
  8652.                   print a "compressed" itemize environment.
  8653.  
  8654.  Example:         !begin_itemize !short
  8655.  
  8656.  See:             !begin_itemize,                    !begin_enumerate,
  8657.                   !begin_description, !use_short_envs
  8658.  
  8659.  
  8660. F.16.4  !sloppy
  8661. ---------------
  8662.  
  8663.  Type & position: switch, main part
  8664.  
  8665.  Syntax:          !sloppy
  8666.  
  8667.  Description:     Switches off warning messages according short lines.
  8668.                   You can use this  command  wherever  you  want.  The
  8669.                   warnings can be enabled with !fussy. When converting
  8670.                   to LaTeX UDO doesn't convert !sloppy into \sloppy!
  8671.  
  8672.  See:             !fussy
  8673.  
  8674.  
  8675. F.16.5  !smallskip
  8676. ------------------
  8677.  
  8678.  Type & position: command, main part
  8679.  
  8680.  Syntax:          !smallskip
  8681.  
  8682.  Description:     This   command   will   be   simplay   replaced   by
  8683.                   "\smallskip"  when converted to LaTeX. Otherwise one
  8684.                   additional empty line will be generated.
  8685.  
  8686.  See:             !medskip, !bigskip
  8687.  
  8688.  
  8689. F.16.6  !sort_hyphen_file
  8690. -------------------------
  8691.  
  8692.  Type & position: switch, preamble
  8693.  
  8694.  Syntax:          !sort_hyphen_file [<abbreviations>]
  8695.  
  8696.  Description:     If this switch is used inside the preamble UDO  will
  8697.                   read  the  hyphenation file, delete entries that are
  8698.                   used more than once and will save a  sorted  version
  8699.                   of  this  hyphenation file. The example shows how to
  8700.                   do this for ASCII and ST-Guide.
  8701.  
  8702.  Example:         !sort_hyphen_file [asc,stg]
  8703.  
  8704.  See:             !hyphen
  8705.  
  8706.  
  8707. F.16.7  !stg
  8708. ------------
  8709.  
  8710.  Type & position: command, preamble & main part
  8711.  
  8712.  Syntax:          !stg <text>
  8713.  
  8714.  Description:     "<text>" is only given out if you convert  into  ST-
  8715.                   Guide. "<text>" will be not converted!
  8716.  
  8717.  Example:         !stg @subject "Documentation\Utilities
  8718.  
  8719.  See:             !=stg, raw environment
  8720.  
  8721.  
  8722. F.16.8  !stg_no_database
  8723. ------------------------
  8724.  
  8725.  Type & position: switch, preamble
  8726.  
  8727.  Syntax:          !stg_no_database
  8728.  
  8729.  Description:     Switches  off  the  output of the ST-Guide @database
  8730.                   line.
  8731.  
  8732.  
  8733. F.16.9  !street
  8734. ---------------
  8735.  
  8736.  Type & position: command, preamble
  8737.  
  8738.  Syntax:          !street <text>
  8739.  
  8740.  Description:     "<text>" will be displayed below  the  name  of  the
  8741.                   author to show in which street you live.
  8742.  
  8743.  Example:         !street Asmecke 1
  8744.  
  8745.  See:             !maketitle, Title page
  8746.  
  8747.  
  8748. F.16.10  !subheading
  8749. --------------------
  8750.  
  8751.  Type & position: command, main part
  8752.  
  8753.  Syntax:          !subheading <text>
  8754.  
  8755.  Description:     This command prints out "<text>" as a headline using
  8756.                   the section font and fontsize.
  8757.  
  8758.  See:             !heading, !subsubheading
  8759.  
  8760.  
  8761. F.16.11  !subnode
  8762. -----------------
  8763.  
  8764.  Type & position: command, main part
  8765.  
  8766.  Syntax:          !subnode <text>
  8767.  
  8768.  Description:     Starts a new section named "<text>".
  8769.  
  8770.  Example:         !subnode Section title
  8771.  
  8772.  See:             !node, !subsubnode, !subsubsubnode, Structuring
  8773.  
  8774.  
  8775. F.16.12  !subnode*
  8776. ------------------
  8777.  
  8778.  Type & position: command, main part
  8779.  
  8780.  Syntax:          !subnode* <text>
  8781.  
  8782.  Description:     This command does the same  as  !subnode,  but  here
  8783.                   "<text>" will not appear in a table of contents.
  8784.  
  8785.  Example:         !subnode* Section title
  8786.  
  8787.  See:             !subnode, !psubnode*, Structuring
  8788.  
  8789.  
  8790. F.16.13  !subsubheading
  8791. -----------------------
  8792.  
  8793.  Type & position: command, main part
  8794.  
  8795.  Syntax:          !subsubheading <text>
  8796.  
  8797.  Description:     This command prints out "<text>" as a headline using
  8798.                   the subsubnode font and fontsize.
  8799.  
  8800.  See:             !heading, !subheading
  8801.  
  8802.  
  8803. F.16.14  !subsubnode
  8804. --------------------
  8805.  
  8806.  Type & position: command, main part
  8807.  
  8808.  Syntax:          !subsubnode <text>
  8809.  
  8810.  Description:     Starts a new subsection named "<text>".
  8811.  
  8812.  Example:         !subsubnode Subsection title
  8813.  
  8814.  See:             !node, !subnode, Structuring
  8815.  
  8816.  
  8817. F.16.15  !subsubnode*
  8818. ---------------------
  8819.  
  8820.  Type & position: command, main part
  8821.  
  8822.  Syntax:          !subsubnode* <text>
  8823.  
  8824.  Description:     This command does the same as !subsubnode, but  here
  8825.                   "<text>" will not appear in a table of contents.
  8826.  
  8827.  Example:         !subsubnode* Subsection title
  8828.  
  8829.  See:             !subsubnode, !psubsubnode*, Structuring
  8830.  
  8831.  
  8832. F.16.16  !subsubsubheading
  8833. --------------------------
  8834.  
  8835.  Type & position: command, main part
  8836.  
  8837.  Syntax:          !subsubsubheading <text>
  8838.  
  8839.  Description:     This command prints out "<text>" as a headline using
  8840.                   the subsubsubnode font and fontsize.
  8841.  
  8842.  See:             !heading, !subheading, !subsubheading
  8843.  
  8844.  
  8845. F.16.17  !subsubsubnode
  8846. -----------------------
  8847.  
  8848.  Type & position: command, main part
  8849.  
  8850.  Syntax:          !subsubsubnode <text>
  8851.  
  8852.  Description:     Starts a new paragraph  named  "<text>".  Paragraphs
  8853.                   are  numbered  with #.#.#.# and are displayed inside
  8854.                   the table of contents
  8855.  
  8856.  Example:         !subsubsubnode Paragraph title
  8857.  
  8858.  See:             !psubsubsubnode, !subnode, !subsubnode, Structuring
  8859.  
  8860.  
  8861. F.16.18  !subsubsubnode*
  8862. ------------------------
  8863.  
  8864.  Type & position: command, main part
  8865.  
  8866.  Syntax:          !subsubsubnode* <text>
  8867.  
  8868.  Description:     This command does the same  as  !subsubsubnode,  but
  8869.                   here  "<text>"  will  not  appear  in  the  table of
  8870.                   contents.
  8871.  
  8872.  Example:         !subsubsubnode* Paragraph title
  8873.  
  8874.  See:             !psubsubsubnode, !subnode, !subsubnode, Structuring
  8875.  
  8876.  
  8877. F.16.19  !subsubtoc
  8878. -------------------
  8879.  
  8880.  Type & position: command, main part
  8881.  
  8882.  Syntax:          !subsubtoc
  8883.  
  8884.  Description:     Lists all subsections of a  section  to  enable  the
  8885.                   reader of a hypertext to switch to the subsections.
  8886.  
  8887.  Example:         !subsubtoc [html,pch,stg,win]
  8888.  
  8889.  See:             !tableofcontents,           !toc,           !subtoc,
  8890.                   !use_auto_subsubtocs, Tables of contents
  8891.  
  8892.  
  8893. F.16.20  !subtoc
  8894. ----------------
  8895.  
  8896.  Type & position: command, main part
  8897.  
  8898.  Syntax:          !subtoc
  8899.  
  8900.  Description:     Lists all sections of a chapter to enable the reader
  8901.                   of a hypertext to siwtch to the sections.
  8902.  
  8903.  Example:         !subtoc [html,pch,stg,win]
  8904.  
  8905.  See:             !tableofcontents,          !toc,         !subsubtoc,
  8906.                   !use_auto_subtocs, Tables of contents
  8907.  
  8908.  
  8909. F.16.21  (!short_today)
  8910. -----------------------
  8911.  
  8912.  Type & position: placeholder, preamble & main part
  8913.  
  8914.  Syntax:          (!short_today)
  8915.  
  8916.  Description:     This placeholder will be replaced by the short  form
  8917.                   of the current date.
  8918.  
  8919.  Example:         (!short_today) becomes 1997/01/04
  8920.  
  8921.  See:             (!today), !language
  8922.  
  8923.  
  8924. F.17  T...
  8925. ==========
  8926.  
  8927.  
  8928. F.17.1  !=tex
  8929. -------------
  8930.  
  8931.  Type & position: command, preamble & main part
  8932.  
  8933.  Syntax:          !=tex <text>
  8934.  
  8935.  Description:     "<text>"  will  only be printed if you don't convert
  8936.                   into LaTeX. "<text>" will be not converted!
  8937.  
  8938.  See:             !tex, !ifdest, raw environment
  8939.  
  8940.  
  8941. F.17.2  !table_caption
  8942. ----------------------
  8943.  
  8944.  Type & position: command, main part
  8945.  
  8946.  Syntax:          !table_caption <text>
  8947.  
  8948.  Description:     Use this command to set the title of the next table.
  8949.                   You have to use this command outside the table envi-
  8950.                   ronment. For the first table of your source file UDO
  8951.                   will  print  "Table 1: A table" if you use the lower
  8952.                   example.
  8953.  
  8954.  Example:         !table_caption A table
  8955.  
  8956.  See:             Tables, !table_caption*
  8957.  
  8958.  
  8959. F.17.3  !table_caption*
  8960. -----------------------
  8961.  
  8962.  Type & position: command, main part
  8963.  
  8964.  Syntax:          !table_caption* <text>
  8965.  
  8966.  Description:     The difference between this and  the  !table_caption
  8967.                   command is that UDO won't print "Table <no>:" before
  8968.                   the table caption.
  8969.  
  8970.  Example:         !table_caption* A table
  8971.  
  8972.  See:             Tables, !table_caption
  8973.  
  8974.  
  8975. F.17.4  !table_counter
  8976. ----------------------
  8977.  
  8978.  Type & position: switch, preamble
  8979.  
  8980.  Syntax:          !table_counter [<value>]
  8981.  
  8982.  Description:     With this switch you can set the table  counter.  If
  8983.                   you  use  the lower example the caption of the first
  8984.                   table will look like this: "Table 5: ...".
  8985.  
  8986.  Example:         !table_counter 5
  8987.  
  8988.  See:             Tables
  8989.  
  8990.  
  8991. F.17.5  !tableofcontents
  8992. ------------------------
  8993.  
  8994.  Type & position: command, main part
  8995.  
  8996.  Syntax:          !tableofcontents
  8997.  
  8998.  Description:     Generates a full table  of  contents  with  specific
  8999.                   commands  of  the destination format. I recommend to
  9000.                   use this command right after  using  !begin_document
  9001.                   or !maketitle.
  9002.  
  9003.  See:             Tables of contents, !use_short_toc
  9004.  
  9005.  
  9006. F.17.6  !tabwidth
  9007. -----------------
  9008.  
  9009.  Type & position: command, preamble & main part
  9010.  
  9011.  Syntax:          !tabwidth <value>
  9012.  
  9013.  Description:     If  lines  that  are  part of a verbatim environment
  9014.                   contain TABs (ASCII 9) UDO will replace  them  by  a
  9015.                   specific  number of blanks. E.g. if you have written
  9016.                   a C source code using a tabwidth of 3 and  you  want
  9017.                   to  print  it  with UDO you can use !tabwidth 3. You
  9018.                   can reset this value before every verbatim  environ-
  9019.                   ment. UDO will use a value of 8 by default.
  9020.  
  9021.  Example:         !tabwidth 3
  9022.  
  9023.  See:             verbatim environment, !vinclude
  9024.  
  9025.  
  9026. F.17.7  !tex
  9027. ------------
  9028.  
  9029.  Type & position: command, preamble & main part
  9030.  
  9031.  Syntax:          !tex <text>
  9032.  
  9033.  Description:     "<text>"  is  only  given  out  if  you convert into
  9034.                   LaTeX. "<text>" will be not converted!
  9035.  
  9036.  Example:         !tex \parindent 0pt
  9037.  
  9038.  See:             !=tex, raw environment
  9039.  
  9040.  
  9041. F.17.8  !tex_2e
  9042. ---------------
  9043.  
  9044.  Type & position: switch, preamble
  9045.  
  9046.  Syntax:          !tex_2e
  9047.  
  9048.  Description:     UDO will output special LaTeX2e commands if you  use
  9049.                   this command e.g. \textbf{...} instead of {\bf ...}
  9050.  
  9051.  
  9052. F.17.9  !tex_dpi
  9053. ----------------
  9054.  
  9055.  Type & position: command, preamble & main part
  9056.  
  9057.  Syntax:          !tex_dpi <value>
  9058.  
  9059.  Description:     Sets  the  resolution  with  which  images should be
  9060.                   output via LaTeX.
  9061.  
  9062.  Example:         !tex_dpi 100
  9063.  
  9064.  See:             !tex_strunk,   !tex_lindner,   !tex_emtex,   !image,
  9065.                   Images
  9066.  
  9067.  
  9068. F.17.10  !tex_emtex
  9069. -------------------
  9070.  
  9071.  Type & position: switch, preamble
  9072.  
  9073.  Syntax:          !tex_emtex
  9074.  
  9075.  Description:     This  switch  says  UDO  to  generate  special emTeX
  9076.                   commands  to  display  Microsoft  Paintshop  Bitmaps
  9077.                   (*.msp) when using the !image command.
  9078.  
  9079.  See:             !tex_strunk, !tex_lindner, !image, Images
  9080.  
  9081.  
  9082. F.17.11  !tex_lindner
  9083. ---------------------
  9084.  
  9085.  Type & position: switch, preamble
  9086.  
  9087.  Syntax:          !tex_lindner
  9088.  
  9089.  Description:     This switch says UDO to generate special Lindner-TeX
  9090.                   commands to display GEM images when using the !image
  9091.                   command.
  9092.  
  9093.  See:             !tex_strunk, !tex_emtex, !image, Images
  9094.  
  9095.  
  9096. F.17.12  !tex_strunk
  9097. --------------------
  9098.  
  9099.  Type & position: switch, preamble
  9100.  
  9101.  Syntax:          !tex_strunk
  9102.  
  9103.  Description:     This  switch says UDO to generate special Strunk-TeX
  9104.                   commands to display GEM images when using the !image
  9105.                   command.
  9106.  
  9107.  See:             !tex_lindner, !tex_emtex, !image, Images
  9108.  
  9109.  
  9110. F.17.13  !tex_verb
  9111. ------------------
  9112.  
  9113.  Type & position: command, preamble & main part
  9114.  
  9115.  Syntax:          !tex_verb <char>
  9116.  
  9117.  Description:     "<char"  will  be  used  as  the  sign for the LaTeX
  9118.                   command \verb. "+" will be used by default.
  9119.  
  9120.  Example:         !tex_verb |
  9121.  
  9122.  See:             (!V)...(!v)
  9123.  
  9124.  
  9125. F.17.14  !title
  9126. ---------------
  9127.  
  9128.  Type & position: command, preamble
  9129.  
  9130.  Syntax:          !title <text>
  9131.  
  9132.  Description:     "<text>" will be displayed on the  titlepage  before
  9133.                   the  contents of !program. It's also used inside the
  9134.                   headlines.
  9135.  
  9136.  Example:         !title The guide to
  9137.  
  9138.  See:             !maketitle, Title page
  9139.  
  9140.  
  9141. F.17.15  !toc
  9142. -------------
  9143.  
  9144.  Type & position: command, main part
  9145.  
  9146.  Syntax:          !toc [<abbreviations>]
  9147.  
  9148.  Description:     Outputs a table of contents without special page  or
  9149.                   hypertext  commands. The example shows how to output
  9150.                   a table of contents (as raw text) for the ST-Guide.
  9151.  
  9152.  Example:         !toc [stg]
  9153.  
  9154.  See:             !tableofcontents,  !subtoc,  !subsubtoc,  Tables  of
  9155.                   contents
  9156.  
  9157.  
  9158. F.17.16  !toc_offset
  9159. --------------------
  9160.  
  9161.  Type & position: switch, preamble
  9162.  
  9163.  Syntax:          !toc_offset <value>
  9164.  
  9165.  Description:     "<value>"  is  added  to  the current chapter number
  9166.                   when printing a  chapter  headline  or  a  table  of
  9167.                   contents. The example shows how to set the number of
  9168.                   the first  chapter  to  10.  You  can  use  negative
  9169.                   values,  too.  This switch has no effect to chapters
  9170.                   of the appendix.
  9171.  
  9172.  Example:         !toc_offset 9
  9173.  
  9174.  
  9175. F.17.17  !town
  9176. --------------
  9177.  
  9178.  Type & position: command, preamble
  9179.  
  9180.  Syntax:          !town <text>
  9181.  
  9182.  Description:     "<text>" will  be  given  out  inside  the  author's
  9183.                   address block on the titlepage.
  9184.  
  9185.  Example:         !town D-59846 Sundern
  9186.  
  9187.  See:             !maketitle, Title page
  9188.  
  9189.  
  9190. F.17.18  (!T)...(!t)
  9191. --------------------
  9192.  
  9193.  Type & position: placeholder, preamble & main part
  9194.  
  9195.  Syntax:          (!T)<text>(!t)
  9196.  
  9197.  Description:     "<text>"   will   be   displayed  in  typewriter  if
  9198.                   possible.
  9199.  
  9200.  Example:         (!T)monospaced(!t)
  9201.  
  9202.  See:             Emphasizing text
  9203.  
  9204.  
  9205. F.17.19  (!TeX)
  9206. ---------------
  9207.  
  9208.  Type & position: placeholder, preamble & main part
  9209.  
  9210.  Syntax:          (!TeX)
  9211.  
  9212.  Description:     This placeholder will  be  replaced  by  \TeX{} when
  9213.                   converting to LaTeX. Otherwise it will be replace by
  9214.                   "TeX".
  9215.  
  9216.  Example:         (!TeX) is printed as TeX
  9217.  
  9218.  See:             (!LaTeX), (!LaTeXe)
  9219.  
  9220.  
  9221. F.17.20  (!today)
  9222. -----------------
  9223.  
  9224.  Type & position: placeholder, preamble & main part
  9225.  
  9226.  Syntax:          (!today)
  9227.  
  9228.  Description:     This placeholder will be replaced by the  long  form
  9229.                   of the current date.
  9230.  
  9231.  Example:         (!today) becomes January 4, 1997
  9232.  
  9233.  See:             (!short_today), !language
  9234.  
  9235.  
  9236. F.18  U...
  9237. ==========
  9238.  
  9239.  
  9240. F.18.1  !universal_charset
  9241. --------------------------
  9242.  
  9243.  Type & position: switch, preamble & main part
  9244.  
  9245.  Syntax:          !universal_charset [ on | off ]
  9246.  
  9247.  Description:     `!universal_charset [on]'  switches  on the usage of
  9248.                   the  universal  charset,  `!universal_charset [off]'
  9249.                   switches it off. UDO won't use the universal charset
  9250.                   by default because it takes some time  to  look  for
  9251.                   and convert these special characters.
  9252.  
  9253.  Example:         !universal_charset [on]
  9254.  
  9255.  See:             Universal charset
  9256.  
  9257.  
  9258. F.18.2  !unset
  9259. --------------
  9260.  
  9261.  Type & position: command, preamble & main part
  9262.  
  9263.  Syntax:          !unset <text>
  9264.  
  9265.  Description:     With  this  command you can delete a symbol that was
  9266.                   set with !set or with the command line option -D.
  9267.  
  9268.  See:             !set, !ifset, !ifnset, Symbols
  9269.  
  9270.  
  9271. F.18.3  !use_about_udo
  9272. ----------------------
  9273.  
  9274.  Type & position: switch, preamble
  9275.  
  9276.  Syntax:          !use_about_udo [<abbreviations>]
  9277.  
  9278.  Description:     This command switches on the usage of  a  page  with
  9279.                   information  about  UDO. This page doesn't appear in
  9280.                   tables of contents. If you want to tell anybody else
  9281.                   about  UDO  please  add this switch to your preamble
  9282.                   and insert `UDO5' somewhere in your source file. The
  9283.                   example  shows  how  to add this information page in
  9284.                   Windows Help, ST-Guide and Pure C Help.
  9285.  
  9286.  Example:         !use_about_udo [stg,win,pch]
  9287.  
  9288.  
  9289. F.18.4  !use_alias_inside_index
  9290. -------------------------------
  9291.  
  9292.  Type & position: switch, preamble
  9293.  
  9294.  Syntax:          !use_alias_inside_index [<abbreviations>]
  9295.  
  9296.  Description:     If you use this switch inside the preamble  of  your
  9297.                   source file all aliases will be printed in the index
  9298.                   of the given destination formats.
  9299.  
  9300.  Example:         !use_alias_inside_index [win,stg]
  9301.  
  9302.  See:             Indices, !no_index, !index, !alias
  9303.  
  9304.  
  9305. F.18.5  !use_ansi_tables
  9306. ------------------------
  9307.  
  9308.  Type & position: switch, preamble
  9309.  
  9310.  Syntax:          !use_ansi_tables [<abbreviations>]
  9311.  
  9312.  Description:     If you use this switch inside  the  preamble  tables
  9313.                   will  be  printed  with  graphic  chars from the DOS
  9314.                   characterset.  This  switch  has  no  function  when
  9315.                   converting into LaTeX, WinHelp or HTML.
  9316.  
  9317.  Example:         !use_ansi_tables [stg]
  9318.  
  9319.  See:             !begin_table, Tables
  9320.  
  9321.  
  9322. F.18.6  !use_auto_subsubsubtocs
  9323. -------------------------------
  9324.  
  9325.  Type & position: switch, preamble
  9326.  
  9327.  Syntax:          !use_auto_subsubsubtocs [<abbreviations>]
  9328.  
  9329.  Description:     Tells   UDO   to   use   the  !subsubsubtoc  command
  9330.                   automatically in every subsection. The example shows
  9331.                   how to use them inside the hypertext formats.
  9332.  
  9333.  Example:         !use_auto_subsubsubtocs [html,pch,stg,win]
  9334.  
  9335.  See:             !subsubsubtoc,   !ignore_subsubsubtoc,   Tables   of
  9336.                   contents
  9337.  
  9338.  
  9339. F.18.7  !use_auto_subsubtocs
  9340. ----------------------------
  9341.  
  9342.  Type & position: switch, preamble
  9343.  
  9344.  Syntax:          !use_auto_subsubtocs [<abbreviations>]
  9345.  
  9346.  Description:     Tells   UDO   to   use   the   !subsubtoc    command
  9347.                   automatically  in  every  section. The example shows
  9348.                   how to use them inside the hypertext formats.
  9349.  
  9350.  Example:         !use_auto_subsubtocs [html,pch,stg,win]
  9351.  
  9352.  See:             !subsubtoc, !ignore_subsubtoc, Tables of contents
  9353.  
  9354.  
  9355. F.18.8  !use_auto_subtocs
  9356. -------------------------
  9357.  
  9358.  Type & position: switch, preamble
  9359.  
  9360.  Syntax:          !use_auto_subtocs [<abbreviations>]
  9361.  
  9362.  Description:     Tells UDO to use the !subtoc  command  automatically
  9363.                   in  every chapter. The example shows how to use them
  9364.                   inside the hypertext formats.
  9365.  
  9366.  Example:         !use_auto_subtocs [html,pch,stg,win]
  9367.  
  9368.  See:             !subtoc, !ignore_subtoc, Tables of contents
  9369.  
  9370.  
  9371. F.18.9  !use_chapter_images
  9372. ---------------------------
  9373.  
  9374.  Type & position: switch, preamble
  9375.  
  9376.  Syntax:          !use_chapter_images [<abbreviations>]
  9377.  
  9378.  Description:     This command switches on the usage of chapter images
  9379.                   instead  of  chapter  titles.  Chapters that use the
  9380.                   !chapterimage command will use an image instead. The
  9381.                   example demonstrates this for Windows Help, HTML and
  9382.                   ST-Guide).
  9383.  
  9384.  Example:         !use_chapter_images [html,win,stg]
  9385.  
  9386.  See:             !chapterimage
  9387.  
  9388.  
  9389. F.18.10  !use_formfeed
  9390. ----------------------
  9391.  
  9392.  Type & position: switch, preamble
  9393.  
  9394.  Syntax:          !use_formfeed [<abbreviations>]
  9395.  
  9396.  Description:     With this switch you can tell UDO to output  a  form
  9397.                   feed (ASCII 12) when handling the !newpage-command.
  9398.  
  9399.  Example:         !use_formfeed [asc]
  9400.  
  9401.  See:             !man_lpp, !newpage
  9402.  
  9403.  
  9404. F.18.11  !use_justification
  9405. ---------------------------
  9406.  
  9407.  Type & position: switch, preamble
  9408.  
  9409.  Syntax:          !use_justification [<abbreviations>]
  9410.  
  9411.  Description:     If  you use this switch inside the preamble UDO will
  9412.                   print text with  justification  if  the  destination
  9413.                   format   supports   it.   RTF  and  LaTeX  will  use
  9414.                   justification by  default,  Windows  Help  and  HTML
  9415.                   don't support justification.
  9416.  
  9417.  Example:         !use_justification [asc]
  9418.  
  9419.  
  9420. F.18.12  !use_label_inside_index
  9421. --------------------------------
  9422.  
  9423.  Type & position: switch, preamble
  9424.  
  9425.  Syntax:          !use_label_inside_index [<abbreviations>]
  9426.  
  9427.  Description:     If  you  use this switch inside the preamble of your
  9428.                   source file all labels will be printed in the  index
  9429.                   of the given destination formats.
  9430.  
  9431.  Example:         !use_label_inside_index [win,stg]
  9432.  
  9433.  See:             Indices, !no_index, !index, !label
  9434.  
  9435.  
  9436. F.18.13  !use_nodes_inside_index
  9437. --------------------------------
  9438.  
  9439.  Type & position: switch, preamble
  9440.  
  9441.  Syntax:          !use_nodes_inside_index [<abbreviations>]
  9442.  
  9443.  Description:     If  you  use this switch inside the preamble of your
  9444.                   source file all chapter titles will  be  printed  in
  9445.                   the index of the given destination formats.
  9446.  
  9447.  Example:         !use_nodes_inside_index [win,stg]
  9448.  
  9449.  See:             Indices, !no_index, !index, !node
  9450.  
  9451.  
  9452. F.18.14  !use_output_buffer
  9453. ---------------------------
  9454.  
  9455.  Type & position: switch, preamble
  9456.  
  9457.  Syntax:          !use_output_buffer [<abbreviations>]
  9458.  
  9459.  Description:     For  all  destination formats UDO breaks lines after
  9460.                   the amount of characters  you  set  with  !parwidth.
  9461.                   When  converting  to  Windows  Help  or  HTML it can
  9462.                   happen that UDO makes mistakes when inserting links.
  9463.                   If  you  use  this  switch UDO will print a complete
  9464.                   paragraph into  the  output  buffer,  it  will  then
  9465.                   insert the links and in the final step it will break
  9466.                   the  lines.  Because  this  method  slows  down  the
  9467.                   conversion  of  the  source file UDO doesn't use the
  9468.                   output
  9469.  
  9470.  Example:         !use_output_buffer [win,html]
  9471.  
  9472.  See:             !parwidth
  9473.  
  9474.  
  9475. F.18.15  !use_short_envs
  9476. ------------------------
  9477.  
  9478.  Type & position: switch, preamble
  9479.  
  9480.  Syntax:          !use_short_envs [<abbreviations>]
  9481.  
  9482.  Description:     If you use this swicth inside the preamble  of  your
  9483.                   source file UDO will print all environments (without
  9484.                   the   verbatim   environment)   without   additional
  9485.                   horizontal  space.  The  example  shows  how  to use
  9486.                   "compressed" environments by default for  the  ASCII
  9487.                   format.
  9488.  
  9489.  Example:         !use_short_envs [asc]
  9490.  
  9491.  See:             !begin_itemize,                    !begin_enumerate,
  9492.                   !begin_description, !begin_xlist
  9493.  
  9494.  
  9495. F.18.16  !use_short_toc
  9496. -----------------------
  9497.  
  9498.  Type & position: switch, preamble
  9499.  
  9500.  Syntax:          !use_short_toc [<abbreviations>]
  9501.  
  9502.  Description:     Tells UDO to output short tables of contents. In the
  9503.                   main  table  of  contents  only  the  names  of  the
  9504.                   chapters and in chapters only the names of  sections
  9505.                   will be printed.
  9506.  
  9507.  Example:         !use_short_toc [all]
  9508.  
  9509.  See:             !tableofcontents, Tables of contents
  9510.  
  9511.  
  9512. F.18.17  !use_style_book
  9513. ------------------------
  9514.  
  9515.  Type & position: switch, preamble
  9516.  
  9517.  Syntax:          !use_style_book [<abbreviations>]
  9518.  
  9519.  Description:     When  converting  into  LaTeX  UDO  outputs \chapter
  9520.                   instead of \section, \section instead of \subsection
  9521.                   and   \subsection instead  of  \subsubsection.  When
  9522.                   converting to other formats a booklike  output  will
  9523.                   be made, that means that chapters will be printed as
  9524.                   "Chapter #".
  9525.  
  9526.  Example:         !use_style_book [tex]
  9527.  
  9528.  
  9529. F.18.18  (!U)...(!u)
  9530. --------------------
  9531.  
  9532.  Type & position: placeholder, preamble & main part
  9533.  
  9534.  Syntax:          (!U)<text>(!u)
  9535.  
  9536.  Description:     "<text>" will be displayed underlined if possible.
  9537.  
  9538.  Example:         (!U)underlined(!u)
  9539.  
  9540.  See:             Emphasizing text
  9541.  
  9542.  
  9543. F.19  V...
  9544. ==========
  9545.  
  9546.  
  9547. F.19.1  !verbatimsize
  9548. ---------------------
  9549.  
  9550.  Type & position: switch, preamble & main part
  9551.  
  9552.  Syntax:          !verbatimsize [tiny|small|normal|large|huge]
  9553.  
  9554.  Description:     With this switch  you  can  set  the  font  size  of
  9555.                   verbatim  environments  if  the  destination  format
  9556.                   allows it to use differnet font sizes. You  can  use
  9557.                   this  switch  wherever  you  want. The smallest font
  9558.                   size is activated with `tiny', the largest one  with
  9559.                   `huge'. The default font size is `normal'.
  9560.  
  9561.  Example:         !verbatimsize [small]
  9562.  
  9563.  See:             verbatim environment
  9564.  
  9565.  
  9566. F.19.2  !version
  9567. ----------------
  9568.  
  9569.  Type & position: command, preamble
  9570.  
  9571.  Syntax:          !version <text>
  9572.  
  9573.  Description:     "<text>"  will be given out right below the contents
  9574.                   of !program on the titlepage.
  9575.  
  9576.  Example:         !version Release 6
  9577.  
  9578.  See:             !maketitle, Title page
  9579.  
  9580.  
  9581. F.19.3  !vinclude
  9582. -----------------
  9583.  
  9584.  Type & position: command, main part
  9585.  
  9586.  Syntax:          !vinclude <file>
  9587.  
  9588.  Description:     "<file>"  will  be  included  and   displayed   like
  9589.                   preformated  text  inside a verbatim environment. If
  9590.                   you use this commands inside another environment UDO
  9591.                   indents the contents of this file. UDO converts tabs
  9592.                   according to !tabwidth.
  9593.  
  9594.  Example:         !vinclude hello.c
  9595.  
  9596.  See:             !tabwidth, !include, Split documents, verbatim envi-
  9597.                   ronment
  9598.  
  9599.  
  9600. F.19.4  (!V)...(!v)
  9601. -------------------
  9602.  
  9603.  Type & position: placeholder, preamble & main part
  9604.  
  9605.  Syntax:          (!V)<text>(!v)
  9606.  
  9607.  Description:     "<text>" will be displayed preformated if possible.
  9608.  
  9609.  Example:         (!V)preformated(!v)
  9610.  
  9611.  See:             Emphasizing text, !tex_verb
  9612.  
  9613.  
  9614. F.20  W...
  9615. ==========
  9616.  
  9617.  
  9618. F.20.1  !=win
  9619. -------------
  9620.  
  9621.  Type & position: command, preamble & main part
  9622.  
  9623.  Syntax:          !=win <text>
  9624.  
  9625.  Description:     "<text>"  will  only be printed if you don't convert
  9626.                   into WinHelp. "<text>" will be not converted!
  9627.  
  9628.  See:             !win, !ifdest, raw environment
  9629.  
  9630.  
  9631. F.20.2  !win
  9632. ------------
  9633.  
  9634.  Type & position: command, preamble & main part
  9635.  
  9636.  Syntax:          !win <text>
  9637.  
  9638.  Description:     "<text>" is only  given  out  if  you  convert  into
  9639.                   Windows Help. "<text>" will be not converted!
  9640.  
  9641.  See:             !=win, raw environment
  9642.  
  9643.  
  9644. F.20.3  !win_background
  9645. -----------------------
  9646.  
  9647.  Type & position: command, preamble
  9648.  
  9649.  Syntax:          !win_background [<colour>]
  9650.  
  9651.  Description:     With  this command you can set the background colour
  9652.                   of your Windows Help file. You can use  one  of  the
  9653.                   following  colours: red, green, blue, cyan, magenta,
  9654.                   yellow, grey and white.  But  you  should  use  only
  9655.                   white,  grey and black because the other colours are
  9656.                   quite ugly.
  9657.  
  9658.  Example:         !win_backgound grey
  9659.  
  9660.  
  9661. F.20.4  !win_charwidth
  9662. ----------------------
  9663.  
  9664.  Type & position: switch, preamble & main part
  9665.  
  9666.  Syntax:          !win_charwidth <value>
  9667.  
  9668.  Description:     UDO uses a constant value for calulating the  indent
  9669.                   of  lists  and the widths of table cells. This value
  9670.                   works  even  fine  with  bold   monospaced   capital
  9671.                   letters,  but  if you use normal text the indents or
  9672.                   table cells my be too width.  You  can  adjust  this
  9673.                   value  by  using  !rtf_charwidth.  UDO  uses  150 by
  9674.                   default.
  9675.  
  9676.  Example:         !win_charwidth 100
  9677.  
  9678.  See:             Tables, Lists
  9679.  
  9680.  
  9681. F.20.5  !win_high_compression
  9682. -----------------------------
  9683.  
  9684.  Type & position: switch, preamble
  9685.  
  9686.  Syntax:          !win_high_compression
  9687.  
  9688.  Description:     If you use  this  switch  inside  the  preamble  the
  9689.                   Microsoft  Helpcompiler  will  compress  the Windows
  9690.                   Help file by  about  50%.  The  compression  of  the
  9691.                   Windows  Help file takes some time. A similar result
  9692.                   with  a  faster  compression  you  will   get   with
  9693.                   !win_medium_compression.
  9694.  
  9695.  See:             !win_medium_compression
  9696.  
  9697.  
  9698. F.20.6  !win_inline_bitmaps
  9699. ---------------------------
  9700.  
  9701.  Type & position: switch, preamble
  9702.  
  9703.  Syntax:          !win_inline_bitmaps
  9704.  
  9705.  Description:     If  you  use this switch inside the preamble of your
  9706.                   source file  UDO  will  use  the  RTF  tag  `\bmcwd'
  9707.                   instead  of  `\bmc'  for  displaying images. In this
  9708.                   case you cannot use images larger than 64 KB. Please
  9709.                   read  the  HCP documentation to get more information
  9710.                   about the differences between these two RTF tags.
  9711.  
  9712.  See:             !image
  9713.  
  9714.  
  9715. F.20.7  !win_medium_compression
  9716. -------------------------------
  9717.  
  9718.  Type & position: switch, preamble
  9719.  
  9720.  Syntax:          !win_medium_compression
  9721.  
  9722.  Description:     If you use  this  switch  inside  the  preamble  the
  9723.                   Microsoft  Helpcompiler  will  compress  the Windows
  9724.                   Help file by about  40%.  A  better  result  with  a
  9725.                   slower     compression    you    will    get    with
  9726.                   !win_high_compression.
  9727.  
  9728.  See:             !win_high_compression
  9729.  
  9730.  
  9731. F.20.8  !win_propfont
  9732. ---------------------
  9733.  
  9734.  Type & position: command, preamble
  9735.  
  9736.  Syntax:          !win_propfont <fontname>
  9737.  
  9738.  Description:     With this command you can set the font that will  be
  9739.                   used   to   display   text  inside  a  Windows  Help
  9740.                   hypertext. The default is "Times New Roman".
  9741.  
  9742.  Example:         !win_propfont Arial
  9743.  
  9744.  
  9745. F.21  X...
  9746. ==========
  9747.  
  9748.  
  9749. F.21.1  (!xlink ...)
  9750. --------------------
  9751.  
  9752.  Type & position: placeholder, main part
  9753.  
  9754.  Syntax:          (!xlink [<text>] [<link>])
  9755.  
  9756.  Description:     Useful for references  to  external  documents  like
  9757.                   other  hypertexts  ore  WWW-pages.  In  contrast  to
  9758.                   (!link ...) <link> will  not   be   converted!   The
  9759.                   example  shows  how  to  make  a  link  to a popular
  9760.                   magazine in a HTML  file.  If  <link> is  empty  the
  9761.                   contents of <text> is used.
  9762.  
  9763.  Example:         (!xlink [Playboy] [http://www.playboy.com])
  9764.  
  9765.  See:             (!link ...), (!plink ...), !no_xlinks, Links
  9766.  
  9767.  
  9768. F.22  *...
  9769. ==========
  9770.  
  9771.  
  9772. F.22.1  !~
  9773. ----------
  9774.  
  9775.  Type & position: special character(s), preamble & main part
  9776.  
  9777.  Syntax:          !~
  9778.  
  9779.  Description:     These  characters will be printed as a tilde. Please
  9780.                   remember that a single tilde  is  used  for  a  non-
  9781.                   breaking space.
  9782.  
  9783.  Example:         !~ becomes to ~
  9784.  
  9785.  See:             ~, Non-breaking spaces
  9786.  
  9787.  
  9788. F.22.2  !-
  9789. ----------
  9790.  
  9791.  Type & position: special character(s), preamble & main part
  9792.  
  9793.  Syntax:          !-
  9794.  
  9795.  Description:     With  these characters you can mark the positions of
  9796.                   a word where UDO is allowed  to  split  it  up.  The
  9797.                   example shows how to mark the syllables of "syllabi-
  9798.                   fication".
  9799.  
  9800.  Example:         syl!-labi!-fi!-cation
  9801.  
  9802.  See:             !hyphen
  9803.  
  9804.  
  9805. F.22.3  !!
  9806. ----------
  9807.  
  9808.  Type & position: special character(s), main part
  9809.  
  9810.  Syntax:          !!
  9811.  
  9812.  Description:     Double exclamation marks are used for splitting  the
  9813.                   cells of a table row and for multiple indices.
  9814.  
  9815.  Example:         !index Level 1 !! Level 2
  9816.  
  9817.  See:             Tables, Indices
  9818.  
  9819.  
  9820. F.22.4  !..
  9821. -----------
  9822.  
  9823.  Type & position: special character(s), preamble & main part
  9824.  
  9825.  Syntax:          !..
  9826.  
  9827.  Description:     An  exclamation  mark followed by two points will be
  9828.                   replaced by typographical three points if the desti-
  9829.                   nation  format allows it to display them. If not UDO
  9830.                   will replace them by three normal points.
  9831.  
  9832.  Example:         !.. is converted to ...
  9833.  
  9834.  
  9835. F.22.5  ~
  9836. ---------
  9837.  
  9838.  Type & position: special character(s), preamble & main part
  9839.  
  9840.  Syntax:          ~
  9841.  
  9842.  Description:     The tilde is used for a  non-breaking  space  inside
  9843.                   the UDO syntax. If a tilde is used between words UDO
  9844.                   won't  split  up  them  when   breaking   lines   or
  9845.                   calculating the justification.
  9846.  
  9847.  Example:         42~DM, Dr.~Helmut Kohl
  9848.  
  9849.  See:             !~, Non-breaking spaces
  9850.  
  9851.  
  9852. F.22.6  ""
  9853. ----------
  9854.  
  9855.  Type & position: special character(s), preamble & main part
  9856.  
  9857.  Syntax:          ""
  9858.  
  9859.  Description:     Two  quotes  in  a row will be replaced by one typo-
  9860.                   graphical quote if the destination  format  supports
  9861.                   typographical quotes. If it doesn't UDO will replace
  9862.                   two quotes by one quote.
  9863.  
  9864.  Example:         "typographical quotes"
  9865.  
  9866.  See:             ("")
  9867.  
  9868.  
  9869. F.22.7  ("")
  9870. ------------
  9871.  
  9872.  Type & position: special character(s), preamble & main part
  9873.  
  9874.  Syntax:          ("")
  9875.  
  9876.  Description:     If you want to print two quotes you have  to  insert
  9877.                   them between brackets. If you don't UDO will replace
  9878.                   the two quotes by a typographical quote.
  9879.  
  9880.  See:             ""
  9881.  
  9882.  
  9883. F.22.8  ('')
  9884. ------------
  9885.  
  9886.  Type & position: special character(s), preamble & main part
  9887.  
  9888.  Syntax:          ('')
  9889.  
  9890.  Description:     If you want to print two  apostrophes  you  have  to
  9891.                   insert  them between brackets. If you don't UDO will
  9892.                   replace  the  two  apostrophes  by  a  typographical
  9893.                   apostrophe.
  9894.  
  9895.  See:             ''
  9896.  
  9897.  
  9898. F.22.9  (--)
  9899. ------------
  9900.  
  9901.  Type & position: special character(s), preamble & main part
  9902.  
  9903.  Syntax:          (--)
  9904.  
  9905.  Description:     If  you  want to print two minus characters you have
  9906.                   to insert them between brackets. If  you  don't  UDO
  9907.                   will  replace  the  two  minus characters by a short
  9908.                   dash.
  9909.  
  9910.  See:             --, (---), Dashs
  9911.  
  9912.  
  9913. F.22.10  (---)
  9914. --------------
  9915.  
  9916.  Type & position: special character(s), preamble & main part
  9917.  
  9918.  Syntax:          (---)
  9919.  
  9920.  Description:     If you want to print three minus characters you have
  9921.                   to  insert  them  between brackets. If you don't UDO
  9922.                   will replace the three minus characters  by  a  long
  9923.                   dash.
  9924.  
  9925.  See:             ---, (--), Dachs
  9926.  
  9927.  
  9928. F.22.11  ''
  9929. -----------
  9930.  
  9931.  Type & position: special character(s), preamble & main part
  9932.  
  9933.  Syntax:          ""
  9934.  
  9935.  Description:     Two apostrophes in a row will be replaced by one ty-
  9936.                   pographical apostrophe  if  the  destination  format
  9937.                   supports  typographical  apostrophes.  If it doesn't
  9938.                   UDO will replace two apostrophes by one apostrophe.
  9939.  
  9940.  Example:         `typographical apostrophes'
  9941.  
  9942.  See:             ('')
  9943.  
  9944.  
  9945. F.22.12  --
  9946. -----------
  9947.  
  9948.  Type & position: special character(s), preamble & main part
  9949.  
  9950.  Syntax:          --
  9951.  
  9952.  Description:     Two minus characters in a row will be replaced by  a
  9953.                   short  dash if the destination format supports them.
  9954.                   If the destination format doesn't support  them  UDO
  9955.                   will print one normal minus character instead.
  9956.  
  9957.  Example:         A short - er, ah - dash.
  9958.  
  9959.  See:             (--), Dashs
  9960.  
  9961.  
  9962. F.22.13  ---
  9963. ------------
  9964.  
  9965.  Type & position: special character(s), preamble & main part
  9966.  
  9967.  Syntax:          ---
  9968.  
  9969.  Description:     Three  minus characters in a row will be replaced by
  9970.                   a long dash if the destination format supports them.
  9971.                   If  the  destination format doesn't support them UDO
  9972.                   will print one normal minus character instead.
  9973.  
  9974.  Example:         A long - er, ah - dash
  9975.  
  9976.  See:             (---), Dashs
  9977.  
  9978.  
  9979.  
  9980. ======================================================================
  9981. Appendix
  9982.  
  9983. UDO6
  9984. ======================================================================
  9985.  
  9986.                        This text was made with
  9987.  
  9988.                                  UDO
  9989.  
  9990.                         Release 6 Patchlevel 0
  9991.                                 HP-UX
  9992.  
  9993.                   Copyright (c) 1995, 1996, 1997 by
  9994.                             Dirk Hagedorn
  9995.                               Asmecke 1
  9996.                             59846 Sundern
  9997.                                Germany
  9998.                       MausNet: Dirk Hagedorn@MK2
  9999.                    America Online: DirkHage@aol.com
  10000.  
  10001. UDO is a program that converts files that are written in the Universal
  10002. Document Format into ASCII, ST-Guide, LaTeX, Rich Text Format, Pure C
  10003.  Help, Manualpage, HTML, WinHelp ,Texinfo, Linuxdoc-SGML, LyX, Apple
  10004.  QuickView and Turbo-Vision-Help. Further information and the current
  10005.                        versions can be found at
  10006.  
  10007.                http://members.aol.com/UDOENG/index.htm
  10008.  
  10009.  
  10010.  
  10011.  
  10012.